Skip to content

Describe the external changes review dialog - #664

Open
koppor wants to merge 1 commit into
mainfrom
external-changes-review
Open

Describe the external changes review dialog#664
koppor wants to merge 1 commit into
mainfrom
external-changes-review

Conversation

@koppor

@koppor koppor commented Aug 26, 2026

Copy link
Copy Markdown
Member

The sharing page did not describe what happens after JabRef detects external changes. This adds a short section on the notification and the External Changes Resolver (accept / deny / merge, and that cancelling the dialog applies nothing and keeps the notification).

The cancel behaviour matches JabRef/jabref#16698, so this should be merged together with (or after) that PR.

Low-risk documentation update.

🤖 Generated with Claude Code

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

Copy link
Copy Markdown

PR Summary by Qodo

Document the external changes review workflow

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Document external-change notifications and dismiss/review outcomes.
• Explain resolver decisions, completion state, and cancellation behavior.
Diagram

graph TD
  Disk["Changed bib file"] --> Notice["Change notification"] --> Action{"User action"}
  Action -->|Dismiss| Save["Overwrite on save"]
  Action -->|Review| Resolver["Changes resolver"] --> Complete{"Review complete"}
  Complete -->|Yes| Apply["Apply decisions"]
  Complete -->|Close early| Preserve["Preserve library"]
Loading
High-Level Assessment

Adding the explanation to the existing shared-library guide is the most direct approach because external-change handling belongs in that workflow. The documented cancellation semantics depend on JabRef/jabref#16698, so this documentation should merge with or after that behavioral change.

Files changed (1) +11 / -0

Documentation (1) +11 / -0
sharedbibfile.mdExplain external-change notification and resolver behavior +11/-0

Explain external-change notification and resolver behavior

• Adds a section describing dismissal and review actions for externally modified library files. It explains accept, deny, and merge outcomes, completion state, and the non-destructive behavior of closing an incomplete review.

en/collaborative-work/sharedbibfile.md

@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 start a comment with 'qodo' or '@qodo' to chat about any finding

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

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