Repository navigation
Publish docs/ as a MkDocs website next to the app - #37
Merged
Merged
Conversation
The documentation is built with MkDocs Material (mkdocs.yml, requirements-docs.txt) in a new "Docs" job of build.yml and published under https://firsttris.github.io/reactive-volcano-app/docs/ on every push to main. Pull requests run mkdocs build --strict, so a broken link or anchor fails before it is published. - The deploy job assembles the Pages artifact from the app and the docs site, and docs-only changes now run the workflow - Theme in the app's orange, GitHub-style anchors, mermaid and admonitions - A hook turns links to files outside docs/ (../README.md, ../Dockerfile) into GitHub links, so the Markdown works on GitHub and on the website - The service worker leaves /docs/ to the network instead of answering with the app's index.html - READMEs and the docs describe the website, the local build and the new CI job Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Pbr82fad6qrixb8849N4wK
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.
What
The documentation in
docs/is built with MkDocs Material and published next to the app on GitHub Pages: https://firsttris.github.io/reactive-volcano-app/docs/. Same setup as in ccu-addon-mui, adapted to this repository, where GitHub Pages already hosts the app.How
Docsjob inbuild.yml: pull requests runmkdocs build --strict, so a broken link or anchor (also between pages) fails before it is published. Onmainthe job uploads the site, and the deploy job assembles the Pages artifact from the app (dist/) and the docs (dist/docs/).paths-ignorenow only skips the README files,CONTRIBUTING.mdandLICENSE; changes todocs/run the workflow.mkdocs.yml,requirements-docs.txt,docs/assets/: theme in the app's orange with light/dark toggle, GitHub-style anchors, mermaid, admonitions, edit links, search.docs/hooks/repo_links.py: links fromdocs/to files outside it (../README.md,../Dockerfile, workflow files) become GitHub links while building, so the Markdown works on GitHub and on the website.vite.config.ts: the service worker leaves/docs/to the network (navigateFallbackDenylist) instead of answering with the app'sindex.html.testing.md,releases.md,development.md) describe the website, the local build (mkdocs serve) and the new job.Not included
The Docker image stays the plain app, without the documentation. No Pages setup is needed, the source is already GitHub Actions.
Checked
mkdocs build --strict,npm run lintandnpm run buildpass locally; the denylist entry is in the generatedsw.js.🤖 Generated with Claude Code
https://claude.ai/code/session_01Pbr82fad6qrixb8849N4wK
Generated by Claude Code