Skip to content

Merge duplicated Git integration pages - #722

Open
YasmineBML wants to merge 3 commits into
JabRef:mainfrom
linamedani:fix-issue-714
Open

YasmineBML wants to merge 3 commits into
JabRef:mainfrom
linamedani:fix-issue-714

Conversation

@YasmineBML

Copy link
Copy Markdown

Pull Request Description

Summary

collaborative-work/gitintegration.md (#704) and collaborative-work/git-integration.md (#669) documented the same Git feature, so I merged the content that only existed in gitintegration.md (GitHub repository and PAT creation with the repo scope, what "Share this library to GitHub" does, a new "Pulling and pushing" section) into git-integration.md. I then removed gitintegration.md and its links in SUMMARY.md and the Share overview page, and added a redirect in .gitbook.yml so the old URL keeps working.

Steps to test

  1. Check the preview link in this PR and open the "Share" section: only one Git page ("Git Integration") is listed.
  2. Open "Git Integration" and check the new content: PAT creation, the "Pulling and pushing" section, and the added sentences under "Sharing a library to GitHub".
  3. Open the "Share" overview page: it no longer links to the removed page.
  4. After merge, https://docs.jabref.org/collaborative-work/gitintegration should redirect to https://docs.jabref.org/collaborative-work/git-integration.
  5. Open JabRef and follow the steps described on the page (tested on version: 6.0-beta.1, development build from source, commit 948324d).

Related issues and pull requests

Closes #714
Documents

AI usage

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: 6.0-beta.1, development build from source, commit 948324d)
  • Any links I added or changed work (no 404s)
  • Any images or tables I added display correctly
  • I checked spelling/grammar

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

Copy link
Copy Markdown

PR Summary by Qodo

Consolidate duplicate Git integration documentation

📝 Documentation ⚙️ Configuration changes 🕐 10-20 Minutes

Grey Divider

AI Description

• Merge GitHub setup, authentication, and pull/push guidance into the existing Git Integration page.
• Remove duplicate navigation links so Share presents one Git integration page.
• Redirect the former page URL to preserve existing links.
Diagram

graph TD
  old["Former page URL"] --> redirect["GitBook redirect"] --> page["Git Integration"]
  sidebar["Share sidebar"] --> page
  overview["Share overview"] --> page
Loading
High-Level Assessment

Consolidating into the existing page is the appropriate approach: it preserves a single source of truth while the redirect protects old links. Merely cross-linking the two pages would retain duplicate navigation and maintenance.

Files changed (4) +12 / -8

Documentation (3) +11 / -8
SUMMARY.mdRemove the duplicate Git page from the sidebar +0/-1

Remove the duplicate Git page from the sidebar

• Removes the “Share with Git and GitHub” entry while retaining the existing “Git Integration” entry under Share.

en/SUMMARY.md

README.mdRemove duplicate Git links from the Share overview +0/-7

Remove duplicate Git links from the Share overview

• Removes the redundant Git and GitHub sentence and content reference. The overview still links to the retained Git Integration page.

en/collaborative-work/README.md

git-integration.mdConsolidate GitHub setup and pull/push guidance +11/-0

Consolidate GitHub setup and pull/push guidance

• Adds pull and push behavior, including semantic merge and conflict resolution. It also documents GitHub repository creation, classic PAT creation with the repo scope, and what sharing a library does.

en/collaborative-work/git-integration.md

Other (1) +1 / -0
.gitbook.ymlRedirect the removed Git integration URL +1/-0

Redirect the removed Git integration URL

• Adds a redirect from collaborative-work/gitintegration to the retained Git Integration page, preserving access through the former URL.

.gitbook.yml

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

qodo-free-for-open-source-projects Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Code Review by Qodo

Grey Divider

Resolved findings
1. Warning about sharing unrelated files is dropped ✓ Resolved
Description
The deleted gitintegration.md warned that sharing to GitHub publishes every file in the
libraries directory, and recommended checking that folder or using a .gitignore before sharing.
The merged git-integration.md keeps the GitHub sharing steps but drops this warning, and a search
of en/ finds no remaining copy. Users who follow the "Share this library to GitHub" steps may push
unrelated or sensitive files to a public repository without being told.

2. Beta-only availability note is lost ✓ Resolved
Description
The deleted page opened with a note that the Git features exist only in the v6.0 beta and not in the
standard download. The merged git-integration.md has no such note, so readers on the stable
release will try the steps and find that the menu items are missing. The note is still needed
because the merged page describes the same beta-only features.

Grey Divider

Tip of the day
💡 Did you know, you can ask Qodo to dismiss a finding you disagree with, with your reason on record

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

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.

Remove duplicated information about git integration

2 participants