Skip to content

Fix mermaid syntax - #17093

Merged
subhramit merged 1 commit into
JabRef:mainfrom
Eng-YasminKotb:Fix-mermaid-syntax-to-be-compatable-with-version
Sep 11, 2026
Merged

subhramit merged 1 commit into
JabRef:mainfrom
Eng-YasminKotb:Fix-mermaid-syntax-to-be-compatable-with-version

Conversation

@Eng-YasminKotb

Copy link
Copy Markdown
Contributor

Summary

This diagram fix syntax error compatiblity with GitHub's rendering engine (Mermaid v9.4.3).

jabref-contrib-policy:4.2:reviewed​:ok

image

Steps to test
To test this change, open the developer documentation file where the package structure is explained.

Related issues and pull requests
Closes #16760

AI usage
Claude (Claude Sonnet 5)


Checklist

  • I own the copyright of the code submitted and I license it under the MIT license
  • [/] If AI tools were used, I disclosed them in the "AI usage" section and reviewed, understood, and take full ownership of all AI-generated code
  • [/] I manually tested my changes in running JabRef (always required)
  • [/] I added JUnit tests for changes (if applicable)
  • I added screenshots in the PR description (if change is visible to the user)
  • [/] I added one sentence (max 20 words) to CHANGELOG.md describing the change from the user's point of view (if the change is visible to the user)
  • [/] I checked the user documentation for up to dateness and submitted a pull request to our user documentation repository

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

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Fix GitHub-compatible Mermaid package diagram syntax

🐞 Bug fix 📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Fixes package diagram rendering with GitHub's Mermaid 9.4.3 engine.
• Preserves shared-layer grouping through transparent links and compatible declaration ordering.
Diagram

graph TD
    DOC["Architecture docs"] -->|parsed by| ENGINE["Mermaid 9.4.3"] -->|renders| VIEW["GitHub preview"]
Loading
High-Level Assessment

The current approach is appropriate because it keeps the diagram editable while adapting its layout syntax to GitHub's fixed Mermaid version. Replacing it with a static image would reduce maintainability, while removing the shared grouping would lose architectural context.

Files changed (1) +8 / -13

Other (1) +8 / -13
architecture-and-components.mdMake the package diagram compatible with GitHub Mermaid +8/-13

Make the package diagram compatible with GitHub Mermaid

• Reorders the shared-layer subgraph and replaces the shared placeholder connection with transparent links from the model node. Removes class annotations that are unnecessary for the revised GitHub-compatible rendering.

docs/architecture-and-components.md

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

Copy link
Copy Markdown
Contributor

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 switch off images and animations for a plain-text comment

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@jabref-machine jabref-machine added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Sep 11, 2026
@subhramit
subhramit added this pull request to the merge queue Sep 11, 2026
@github-actions github-actions Bot added the status: to-be-merged PRs which are accepted and should go into the merge-queue. label Sep 11, 2026
Merged via the queue into JabRef:main with commit 6fe29af Sep 11, 2026
93 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: small status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers status: to-be-merged PRs which are accepted and should go into the merge-queue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants