Skip to content

Site Contents

This is roughly the planned structure for the site. One thing to consider is the linkablity of the pages. If another site links to one of the pages, will that be broken if we restructured the site? If we split the pages into folders based on the type of documentation (Explanation, Tutorial, How-to Guide, Reference, etc.), that might be more linkable.

  1. About
  2. Topics
    • Architecture
    • Authentication
    • User Permissions
    • Projects
    • Program Areas
    • Events
    • Affiliates
  3. Tutorials
    • Create a simple React client app
  4. Guides
    • How to set up X
  5. Reference
    • REST API
    • Code Docs
  6. Contributing
    • Developer
      • Joining the Team
      • Development Environment
      • Working with Issues
      • Working with Git
      • Pull Requests
      • Developer Guides
        • Add new model and API endpoints
        • Create initial data scripts
        • Run backend in venv
      • Maintainer Guides
        • Update build dependencies
        • Merge pull requests
      • Tools
        • Scripts
        • MkDocs
        • Docker
        • Pre-commit
        • uv
    • Project Management
    • Documentation