Skip to content

Add documentation for library sharing with Git and GitHub - #704

Open
mvs31415 wants to merge 12 commits into
JabRef:mainfrom
mvs31415:main
Open

mvs31415 wants to merge 12 commits into
JabRef:mainfrom
mvs31415:main

Conversation

@mvs31415

Copy link
Copy Markdown

Pull Request Description

Summary

Addresses #647. Adds documentation in the share page for the library sharing feature using Git and Github described in this blog post.

I created a new page describing the git integration (/en/collaborative-work/gitintegration.md), which lives in the share section. I also modified the README (/en/collaborative-work/README.md) to refer to the new page I created. Note @FunnyGorilla27 also contributed to this PR.

Steps to test

Check /en/collaborative-work/gitintegration.md and /en/collaborative-work/README.md to ensure you are happy with the descriptions, and verify that all links are also working.

Open JabRef and follow the steps described on the page. I tested these by building on source from the version currently on main, and will soon test with v6.0 beta, which appears to be the .

To test the instructions actually work correctly, either build from main or from the v6.0 beta (https://github.com/JabRef/jabref/releases/tag/v6.0-beta.1). The current version on jabref.org currently doesn't support this feature.

Related issues and pull requests

Closes #647.
Documents the changes described in https://blog.jabref.org/2025/11/11/introducing-git-integration-in-jabref/.

AI usage

No AI was used to create this PR.

Checklist

  • I reviewed and take ownership of all content in this PR, including any AI-assisted text
  • I opened JabRef and followed these instructions myself to confirm they still work (tested on version: built from source)
  • Any links I added or changed work (no 404s)
  • Any images or tables I added display correctly
  • I checked spelling/grammar

@mvs31415

Copy link
Copy Markdown
Author

We've now tested the documentation steps are correct on the v6.0 beta version linked in the docs (https://github.com/JabRef/jabref/releases/tag/v6.0-beta.1).

@mvs31415
mvs31415 marked this pull request as ready for review October 23, 2026 09:40
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can reply 'qodo' on any finding to push back, ask questions, or dig deeper

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document sharing JabRef libraries with Git and GitHub

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Add a guide for setting up GitHub sharing and using JabRef’s Git commands.
• Clarify v6.0 beta availability and warn that sharing may include unrelated files.
• Link the guide from the Share page.
Diagram

graph TD
  Index["Share page"] --> Guide["Git guide"] --> Version["Version requirement"] --> Repo["GitHub repository"] --> Credentials["PAT credentials"] --> Sharing["Share library"] --> Commands["Git commands"]
Loading
High-Level Assessment

A dedicated guide linked from the Share page keeps the setup steps separate from the section overview. Consider also adding the guide to SUMMARY.md and the page’s content references so it appears alongside other sharing methods.

Files changed (2) +29 / -0

Documentation (2) +29 / -0
README.mdLink Git and GitHub sharing from the Share page +2/-0

Link Git and GitHub sharing from the Share page

• Adds a short introduction and link to the new Git integration guide.

en/collaborative-work/README.md

gitintegration.mdAdd GitHub library-sharing guide +27/-0

Add GitHub library-sharing guide

• Documents the version prerequisite, repository and token setup, and JabRef’s sharing workflow. Explains commit, push, pull, conflict handling, and the risk of sharing unrelated files.

en/collaborative-work/gitintegration.md

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add information on Git feature in JabRef

1 participant