Skip to content

Describe library synchronization replacing autosave - #672

Open
koppor wants to merge 2 commits into
mainfrom
file-sync
Open

Describe library synchronization replacing autosave#672
koppor wants to merge 2 commits into
mainfrom
file-sync

Conversation

@koppor

@koppor koppor commented Sep 1, 2026

Copy link
Copy Markdown
Member

🤖 Low-risk documentation update: describes the "Synchronize local libraries with their files" option (formerly "Autosave local libraries") introduced in JabRef/jabref#16813, which merges external changes to the library file automatically and asks for a review only on conflicts. Screenshot of the preference updated.

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GWmXyN3GUNhfF9fSo1UNrt
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document bidirectional library synchronization

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Renames autosave documentation to reflect JabRef 6.0's bidirectional library synchronization.
• Explains automatic external-change merging, conflict review, and disabled synchronization
 behavior.
• Aligns documentation navigation and the preference screenshot caption with the renamed option.
Diagram

graph TD
  J["JabRef edits"] -->|Sync on| F["Library file"]
  E["External program"] --> F --> C{"Edit conflict?"}
  C -->|No| M["Automatic merge"] --> L["Open library"]
  C -->|Yes| R["Conflict review"] --> L
  F -->|Sync off| R
Loading
High-Level Assessment

The current approach is appropriate: it expands the existing backup and autosave page while preserving its URL, avoiding unnecessary navigation and link churn. A separate synchronization page was considered but would fragment closely related saving and backup guidance.

Files changed (2) +13 / -6

Documentation (2) +13 / -6
SUMMARY.mdRename the autosave navigation entry +1/-1

Rename the autosave navigation entry

• Renames the advanced documentation entry to reference automatic backup and synchronization while preserving the existing page path.

en/SUMMARY.md

autosave.mdDocument bidirectional library synchronization +12/-5

Document bidirectional library synchronization

• Renames the autosave section for JabRef 6.0 and explains automatic saving, external file merging, conflict review, and behavior when synchronization is disabled. It also updates the preference screenshot caption to use the new terminology.

en/advanced/autosave.md

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

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📜 Skill insights (0)

Grey Divider


Remediation recommended

1. FAQ retains obsolete autosave path 🐞 Bug ≡ Correctness
Description
The new documentation renames the control and locates it under Preferences → General → Saving, but
the performance FAQ still tells users to disable “autosave” under File → Preferences → File →
Saving. Users following that FAQ may be unable to locate the renamed synchronization option.
Code

en/advanced/autosave.md[71]

+JabRef can keep a local library and its `.bib` file the same in both directions. Enable **Synchronize local libraries with their files** in Preferences → General → Saving:
Evidence
The changed synchronization page establishes the new control name and location, while the FAQ still
presents the old autosave terminology and a different navigation path for disabling the same
behavior.

en/advanced/autosave.md[69-77]
en/faq/README.md[38-44]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
Update the performance FAQ so its instruction uses the current synchronization option name and preference location.

## Issue Context
The synchronization page now documents **Synchronize local libraries with their files** under Preferences → General → Saving, while the FAQ retains the former autosave name and a conflicting path.

## Fix Focus Areas
- en/advanced/autosave.md[69-77]
- en/faq/README.md[38-44]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Tip of the day
💡 Did you know, you can describe a rule in plain language on the Rules page and Qodo drafts it for you

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

Comment thread en/advanced/autosave.md
## Automatic saving of the current library
## Automatic saving and synchronization of the current library

JabRef can keep a local library and its `.bib` file the same in both directions. Enable **Synchronize local libraries with their files** in Preferences → General → Saving:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remediation recommended

1. Faq retains obsolete autosave path 🐞 Bug ≡ Correctness

The new documentation renames the control and locates it under Preferences → General → Saving, but
the performance FAQ still tells users to disable “autosave” under File → Preferences → File →
Saving. Users following that FAQ may be unable to locate the renamed synchronization option.
Agent Prompt
## Issue description
Update the performance FAQ so its instruction uses the current synchronization option name and preference location.

## Issue Context
The synchronization page now documents **Synchronize local libraries with their files** under Preferences → General → Saving, while the FAQ retains the former autosave name and a conflicting path.

## Fix Focus Areas
- en/advanced/autosave.md[69-77]
- en/faq/README.md[38-44]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GWmXyN3GUNhfF9fSo1UNrt
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.

1 participant