Migrate docs from mkdocs to great-docs#810
Draft
edavidaja wants to merge 19 commits into
Draft
Conversation
|
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
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.
Migrates the documentation site from mkdocs (Material theme) to great-docs (Quarto-based). Hosting stays on S3 (
docs.posit.co/rsconnect-python); great-docs replaces only the build step. Scope matches the old site: CLI reference + narrative guides + changelog, no Python API reference, single-version.Design spec, implementation plan, and spike findings are under
docs/superpowers/{specs,plans,spikes}/.What changed
great-docs.yml— CLI reference auto-discovered fromrsconnect.main, Python API reference suppressed (reference: false), changelog from GitHub Releases, GTM (GTM-KHBDBW7) via top-levelinclude_in_header, Posit logo/favicon, User Guide order matching the old nav.user_guide/*.qmd— the four narrative pages migrated fromdocs/*.md(prose byte-identical; the single{{ version }}macro dropped — great-docs shows the version automatically).scripts/backfill_release_notes.py(+ tests) — one-time script to backfill the empty GitHub Release bodies fromdocs/CHANGELOG.mdso the auto-changelog has history. Dry-run by default;--applyis gated and idempotent.justfile+ CI/preview workflows — build via great-docs intogreat-docs/_site/, still synced to the existing S3 buckets; Quarto CLI added to CI.mkdocs.yml,docs/commands/,docs/overrides/,docs/css/, command stubs); updatedCLAUDE.md; re-lockeduv.lock(dropped mkdocs deps).Build recipe (spike-confirmed)
just docsprovisions an isolated.venv-docs(Python 3.12) withgreat-docs+pygments+ the project, activated, then runsgreat-docs build. Theuv run --withapproach does not work — Quarto's post-render hook must run under an interpreter that hasgreat_docs/pygmentsimportable.Follow-ups (non-blocking)
uv run python scripts/backfill_release_notes.py(dry-run → 39 releases), then re-run with--apply.quarto-actions/setupcurrently unpinned).commands/*deep-link URLs (nowreference/cli/*).docs/images/.Testing
726 pass. The 4
test_quickstart[shiny]failures are pre-existing (reproduce at04a115a) — anorjsonbuild failure under CPython 3.14-freethreaded, unrelated to this change.🤖 Generated with Claude Code