# mkdocs.yml

site_name: Aegis Stack

site_description: A production-ready Python foundation for builders who refuse to wait.

site_author: Aegis Stack Contributors

site_url: https://lbedner.github.io/aegis-stack/

repo_url: https://github.com/lbedner/aegis-stack

repo_name: lbedner/aegis-stack

theme:

name: material

custom_dir: docs/overrides

logo: images/aegis_stack_layered_shield.svg

favicon: images/aegis_stack_layered_shield.svg

palette:

# Palette toggle for light vs dark mode. ``primary: custom`` is paired

# with the ``--md-primary-fg-color*`` overrides in

# ``docs/stylesheets/custom.css`` so the banner uses Overseer's

# off-black chrome (#090B0D), while Overseer teal (#17CCBF) is reserved

# for accent/link styling — instead of Material's named-colour set.

- scheme: default

primary: custom

toggle:

icon: material/brightness-7

name: Switch to dark mode

- scheme: slate

primary: custom

toggle:

icon: material/brightness-4

name: Switch to light mode

features:

- navigation.tabs

- navigation.top

- search.highlight

- search.suggest

- content.code.copy

- content.code.annotate

# Navigation structure

nav:

- Home:

- Overview: index.md

- Installation: installation.md

- Origin Story:

- About: about.md

- Technology Stack: technology.md

- How I Build: process.md

- Components:

- Overview: components/index.md

- Backend:

- Getting Started: components/backend/index.md

- Middleware:

- Overview: components/backend/middleware.md

- Performance: components/backend/middleware/performance.md

- Lifecycle: components/backend/lifecycle.md

- Routes: components/backend/routes.md

- Authentication Integration: components/backend/auth.md

- API Load Testing: components/backend/load-testing.md

- Database: components/database.md

- Frontend:

- Getting Started: components/frontend/index.md

- Architecture: components/frontend/architecture.md

- Routing & Views: components/frontend/routing.md

- Session State: components/frontend/state.md

- API Client: components/frontend/api-client.md

- Events: components/frontend/events.md

- Example: components/frontend/example.md

- Scheduler:

- Getting Started: components/scheduler.md

- Examples: components/scheduler/examples.md

- CLI Interface: components/scheduler/cli.md

- Extras:

- Database Persistence: components/scheduler/extras/persistence.md

- Worker:

- Getting Started: components/worker/index.md

- Configuration: components/worker/configuration.md

- Examples: components/worker/examples.md

- Extras:

- Load Testing: components/worker/extras/load-testing.md

- Ingress: components/ingress.md

- Observability: components/observability.md

- Services:

- Overview: services/index.md

- AI Service:

- Getting Started: services/ai/index.md

- Illiana: services/ai/illiana.md

- LLM Catalog: services/ai/llm-catalog.md

- RAG: services/ai/rag.md

- Cost Tracking: services/ai/cost-tracking.md

- Voice: services/ai/voice.md

- Engines: services/ai/engines.md

- Provider Setup: services/ai/providers.md

- API Reference: services/ai/api.md

- Service Layer: services/ai/integration.md

- CLI Commands: services/ai/cli.md

- Examples: services/ai/examples.md

- Authentication:

- Getting Started: services/auth/index.md

- Auth Levels: services/auth/levels.md

- API Reference: services/auth/api.md

- Service Layer: services/auth/integration.md

- CLI Commands: services/auth/cli.md

- Examples: services/auth/examples.md

- Blog (Experimental):

- Getting Started: services/blog/index.md

- API Reference: services/blog/api.md

- Dashboard: services/blog/dashboard.md

- CLI Commands: services/blog/cli.md

- Examples: services/blog/examples.md

- Communications:

- Getting Started: services/comms/index.md

- Provider Setup: services/comms/setup.md

- API Reference: services/comms/api.md

- CLI Commands: services/comms/cli.md

- Insights (Experimental):

- Getting Started: services/insights/index.md

- Data Sources: services/insights/data-sources.md

- CLI Commands: services/insights/cli.md

- Dashboard: services/insights/dashboard.md

- Configuration: services/insights/configuration.md

- Examples: services/insights/examples.md

- Payment (Experimental):

- Getting Started: services/payment/index.md

- Provider Setup: services/payment/setup.md

- Dashboard: services/payment/dashboard.md

- API Reference: services/payment/api.md

- CLI Commands: services/payment/cli.md

- Examples: services/payment/examples.md

- Overseer:

- Overview: overseer/index.md

- The Story: overseer/story.md

- Integration: overseer/integration.md

- Deployment:

- Getting Started: deployment/index.md

- Reference:

- CLI Reference: cli-reference.md

- Evolving Your Stack: evolving-your-stack.md

- Integration Patterns: integration-patterns.md

# Plugins

plugins:

- gen-files:

scripts:

- scripts/gen_docs.py

- search

- mkdocstrings:

handlers:

python:

options:

show_root_heading: true

show_source: true

- glightbox:

touchNavigation: true

loop: false

effect: zoom

slide_effect: slide

width: 100%

height: auto

zoomable: true

draggable: true

# Markdown extensions

markdown_extensions:

- admonition

- pymdownx.details

- pymdownx.tabbed:

alternate_style: true

- pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.snippets

- pymdownx.emoji:

emoji_index: !!python/name:material.extensions.emoji.twemoji

emoji_generator: !!python/name:material.extensions.emoji.to_svg

- attr_list

- md_in_html

extra_css:

- stylesheets/custom.css

extra_javascript:

- https://unpkg.com/[email protected]/dist/mermaid.min.js

- javascripts/mermaid-config.js

- javascripts/feedback.js