Add GH pages for docs - #16
Merged
Merged
Conversation
Add a Docs workflow that builds the Quarto site and pushes docs/_build to the gh-pages branch on every push to main (plus manual dispatch). Drop the Netlify deploy and GitHub deployment steps from the CI build-docs job: they depend on NETLIFY_SITE_ID / NETLIFY_AUTH_TOKEN secrets that this fork does not have, so build-docs is now a pure build check. Set site-url and repo-url so Quarto emits a correct sitemap.xml. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The overview content lived in docs/get-started/overview.qmd and was rendered into README.md via docs/GITHUB.qmd and `make docs-build-readme`. README edits therefore silently drifted from the source and would have been overwritten by the next build. The setup was also fragile: removing an unrelated raw block from GITHUB.qmd caused the included file's YAML frontmatter to leak into the README body as literal text. Invert and flatten it: README.md is now hand-written, and overview.qmd simply includes it. This drops GITHUB.qmd, the replace-readme-links Lua filter, the BUILDING_README conditional, the jupyter kernel dependency for that page, and the docs-build-readme target. Two consequences of the flattening: links in the shared content are now absolute site URLs (previously rewritten by the filter), and the docs site shows the screencast thumbnail rather than an embedded player. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
No description provided.