Skip to content

docs: migrate documentation from raw Quarto to Great Docs#211

Merged
chriscarrollsmith merged 1 commit into
mainfrom
205-switch-documentation-system-from-raw-quarto-to-great-docs
Jul 1, 2026
Merged

docs: migrate documentation from raw Quarto to Great Docs#211
chriscarrollsmith merged 1 commit into
mainfrom
205-switch-documentation-system-from-raw-quarto-to-great-docs

Conversation

@chriscarrollsmith

Copy link
Copy Markdown
Contributor

Summary

  • Replace the hand-authored Quarto site with Great Docs using the native user guide flow (user_guide/*.qmd, homepage: user_guide).
  • Swap dev dependency from PyPI quarto to great-docs, add great-docs.yml, and update CI to build/deploy great-docs/_site to GitHub Pages.
  • Keep README as a normal checked-in file and replace the custom RAG bundle with Great Docs-generated llms.txt / llms-full.txt.

Test plan

  • PYTHONPATH=. uv run great-docs build succeeds locally
  • uv run ty check . passes
  • Verify homepage screenshot and generated diagrams render on the published site after merge
  • Confirm GitHub Pages deploy updates https://promptlytechnologies.com/fastapi-jinja2-postgres-webapp/

Closes #205

Replace the hand-authored Quarto site with Great Docs user guide flow so narrative docs build and deploy from user_guide/ while README stays a normal checked-in file.
@chriscarrollsmith chriscarrollsmith linked an issue Jul 1, 2026 that may be closed by this pull request
@chriscarrollsmith
chriscarrollsmith merged commit 8514c59 into main Jul 1, 2026
2 checks passed
@chriscarrollsmith
chriscarrollsmith deleted the 205-switch-documentation-system-from-raw-quarto-to-great-docs branch July 1, 2026 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Switch documentation system from raw Quarto to great-docs

1 participant