[Issue-893] Mermaid diagrams displaying in Github Pages #895
Conversation
Added paths-ignore rules to prevent tests from running on documentation changes.
There was a problem hiding this comment.
Pull request overview
This PR fixes Mermaid diagram rendering on GitHub Pages and optimizes the CI workflow to skip tests for documentation-only changes.
Key Changes:
- Updated documentation link from
GitFlowDiagram.mdtoGitFlow.md - Added Mermaid.js integration via custom head include file
- Configured GitHub Actions to ignore documentation changes when running tests
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/index.md | Updated GitFlow documentation link from GitFlowDiagram.md to GitFlow.md |
| docs/_includes/head-custom.html | Added Mermaid.js script to enable diagram rendering on GitHub Pages |
| docs/_config.yml | Enabled Mermaid support via configuration flag |
| .github/workflows/tests.yml | Added paths-ignore filters to skip test runs for documentation changes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@stardriftfx I've opened a new pull request, #896, to work on those changes. Once the pull request is ready, I'll request review from you. |
|
@stardriftfx I've opened a new pull request, #897, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: stardriftfx <56492920+stardriftfx@users.noreply.github.com>
Co-authored-by: stardriftfx <56492920+stardriftfx@users.noreply.github.com>
Fix path pattern to correctly ignore .github folder in workflow
Fix unclosed Liquid conditional tag in Mermaid configuration
Makes code look nicer.
stiber
left a comment
stiber
left a comment
There was a problem hiding this comment.
This looks great. Could you add documentation for this to docs/Developer/GHPages.md? Also, given our conversation about the gh-pages branch, I just want to confirm that this will work given our orphan branch configuration for publishing...
Done. And yes, based on my forked repo, this should work without modifying the orphan branch's config (gh-pages). |
Closes #893
Description