Skip to main content

Docusaurus Site Organization for Junior Knowledge Base

1. Homepage​

  • Project overview: Vision, elevator pitch, and branding.
  • Quick links: Onboarding, roadmap, architecture, team, etc.

2. Getting Started / Onboarding​

  • How to join/contribute
  • Onboarding guide for new team members
    • Prerequisites
    • Setup instructions
    • First tasks

3. Project Documentation​

  • High-Level Documents
    • Overview & vision (z1)
    • Phase-based plan (z3)
    • Introductory PPT (z2) (link or embed)
  • Roadmap & Milestones
    • Current phase
    • Upcoming features
    • Release schedule

4. Architecture & Technical Docs​

  • System Architecture (z6)
    • Tech stack overview
    • Diagrams & component breakdown
    • Integration plan
  • Design Principles
    • UI/UX standards
    • AI/ML guidelines (if applicable)
  • API Reference
    • Endpoints
    • Data models

5. Team & Roles​

  • Roles & Responsibilities (z5)
  • Org chart
  • How to claim a role / onboarding for managers

6. Work Guide​

  • How to contribute docs/code
  • Style guidelines
  • PR process
  • Issue templates

7. Recruiting / External​

  • Pitch deck (z2)
  • Branding
  • Slogans, vibes, and public positioning

8. FAQ & Troubleshooting​

  • Common issues
  • Contact points

9. Changelog & Updates​

  • Release notes
  • Major decisions

10. References & Resources​

  • External links
  • Further reading
  • Related projects

Folder Structure Suggestion​

  • /docs/ β€” Main content
    • /docs/onboarding/
    • /docs/overview/
    • /docs/roadmap/
    • /docs/architecture/
    • /docs/team/
    • /docs/Work/
    • /docs/recruiting/
    • /docs/faq/
    • /docs/changelog/
    • /docs/resources/
  • /static/ β€” Images, PPTs, diagrams, branding assets
  • /sidebars.js β€” Organize navigation to match the above structure

Tips​

  • Use Markdown for all docs for ease of editing.
  • Link issues (z1–z6) and tasks to relevant docs.
  • Keep navigation cleanβ€”prioritize onboarding and overview for new users.
  • Use tags/categories for discoverability.