chore(readme): fix mermaid role-flow rendering - #14
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only PR to ensure the Mermaid role-flow diagram in README.md renders reliably on GitHub, with a corresponding changelog note.
Changes:
- Adjusted Mermaid flowchart node/label syntax in
README.mdfor GitHub-compatible rendering. - Added a
1.2.1changelog entry describing the README diagram rendering fix.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Updates Mermaid flowchart syntax/labels to improve GitHub rendering reliability. |
| CHANGELOG.md | Adds a 1.2.1 entry documenting the README Mermaid rendering fix. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR contains a focused documentation/rendering fix for the role flow diagram and aligns release notes with that fix.
Related Issues
No linked issue.
Validation
Local checks run:
Release Impact