Add Docusaurus documentation site and GitHub Pages deployment workflow - #165
Merged
Conversation
- Build accessible, plain-language documentation site targeting Docusaurus v3 - Add comprehensive End-user guide, Partner & court configuration guide, and Admin deployment guide - Add interactive walkthrough with screenshots of the reorganized 14-step filing flow - Set up GitHub Pages deployment workflow (.github/workflows/deploy-docs.yml) with custom domain support - Update Django about page to link directly to the docs portal - Update .dockerignore and .gitignore to isolate documentation from container builds
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.
Summary
This PR adds a comprehensive documentation portal built on Docusaurus v3 and configures automated deployment to GitHub Pages at
https://litefile-docs.suffolklitlab.org.What's included:
docs/with custom LIT Lab branding, navigation, and theme colors.docs/docs/user-guide/): Plain-language overview, prerequisite checklist, 14-step reorganized filing walkthrough with screenshots, post-filing tracking, multi-state resources, and FAQ.docs/docs/partners-courts/): Documentation for state/court YAML configuration, document checklists & filing plan rules, AI prompt/hint tuning, and Docassemble / Guided interview integrations.docs/docs/admin/): Architecture overview, environment variables reference, Docker optimization, Fly.io deployment, and AWS S3 storage configuration.docs/developer-notes/(internal vision/eval docs kept in repository but excluded from the public Docusaurus docs tree)..github/workflows/deploy-docs.yml) using official GitHub Actions deployment withCNAMEsupport./aboutpage.AGENTS.md) specifying sentence case, repo conventions, and verification steps.Testing & verification:
npm run buildpassed successfully with zero broken links.pytest(431 passed),ruff check ., andty checkall passed.docs/artifacts.