This directory contains the source files for the MkDocs documentation site.

uv sync --extra docs

Start the development server:

mkdocs serve

The documentation will be available at http://127.0.0.1:8000

Build the static HTML files:

mkdocs build

The output will be in the site/ directory.

If you have GitHub Actions set up, the documentation can be automatically deployed on push to main.

Deploy to GitHub Pages:

mkdocs gh-deploy --force

This will:

1. Build the documentation
2. Push the site/ directory to the gh-pages branch
3. Make it available at https://yourusername.github.io/tradingbot25/

• index.md - Homepage
• getting-started/ - Installation and quick start guides
• architecture/ - System design and architecture
• api/ - Auto-generated API documentation from docstrings
• deployment/ - Kubernetes and Helm deployment guides
• guides/ - In-depth tutorials
• examples/ - Example bot implementations

1. Create a new markdown file in the appropriate directory
2. Add it to the nav section in mkdocs.yml
3. Build and test locally with mkdocs serve

API documentation is automatically generated from docstrings using mkdocstrings. The API pages use the ::: module.Class syntax to include auto-generated documentation.