Skip to content

documentation

Quick Start

Launch the docs: 

mkdocs serve

Visit http://127.0.0.1:8000

Structure

The stucture of the docs currently matches the layout that is present in confluence, as such it may not be optimal. 

docs/
├── .pages              # Main navigation config
├── index.md           # Home page
├── backend/           # Server & infrastructure docs
├── development/       # Dev workflows & procedures  
├── testing-qa/        # Testing & quality assurance
└── containerisation/  # Docker & deployment

Adding Docs

  1. Create markdown files in appropriate docs/ subdirectory
  2. Navigation is auto-generated via .pages files using awesome-pages plugin

Best practices:

  • Use descriptive filenames (user-authentication.md not auth.md)
  • Keep hierarchy organized by topic area

Questions?

If you have any questions, contact Andrew at andrew.cruickshank@methodgrid.com.

Last modified by: Unknown