Skip to content

Conversation

@danoctua
Copy link
Collaborator

Documentation Setup with Docusaurus

Description

This PR sets up a comprehensive documentation site using Docusaurus. It provides a central place for User Guides, Functional Documentation, and Technical References, all styled to match the Access Tool's brand identity.

Checklist

  • I have read the contributing guidelines.
  • I ran all tests and they passed successfully.
  • I added/updated documentation (if applicable).
  • I reviewed my own code and followed the project's code style.
  • I included relevant details in the PR description or commit messages.

Changes

  • Infrastructure: Initialized Docusaurus with TypeScript in the docs/ directory.
  • Styling: Applied the Access Tool design system (SF Pro font, primary blue accents, blurred navbar) for visual consistency with the frontend.
  • Content: Set up the main categories and drafted initial subcategories for User Guide, Functional, and Technical documentation.
  • Deployment: Added a GitHub Actions workflow .github/workflows/deploy-docs.yml for automatic deployment to GitHub Pages.
  • Cleanup: Removed all default Docusaurus blog files and template images to maintain a minimalistic and professional look.

How Has This Been Tested?

  • Build Verification: Successfully ran npm run build in the docs/ directory to ensure zero broken links and valid static file generation.
  • Visual Verification: Checked the landing page and documentation structure on a local development server.

Thank you for contributing! 🎉

@danoctua danoctua self-assigned this Dec 26, 2025
@danoctua danoctua added the documentation Improvements or additions to documentation label Dec 26, 2025
@danoctua danoctua changed the base branch from main to dev December 26, 2025 13:39
Copy link

@jamerson1994-cloud jamerson1994-cloud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gg

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants