Files
the-biergarten-app/mkdocs.yml
Aaron Po 30317326ce Refactor documentation and diagrams for web/pipeline. (#272)
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> for assistance with diagram creation and documentation prose updates.
2026-09-02 01:58:40 -04:00

68 lines
2.3 KiB
YAML

site_name: The Biergarten App
site_url: https://github.io
repo_url: https://github.com
repo_name: the-biergarten-app
theme:
name: material
nav:
- Home: index.md
- Web:
- Architecture: web/architecture.md
- Getting Started: web/getting-started.md
- Database: web/database.md
- Docker: web/docker.md
- Environment Variables: web/environment-variables.md
- Testing: web/testing.md
- Token Validation: web/token-validation.md
- Diagrams:
- Vertical Slice: web/diagrams/vertical-slice.md
- Database Schema: web/diagrams/database-schema.md
- Deployment: web/diagrams/deployment.md
- Auth Flows:
- Registration: web/diagrams/auth/registration.md
- Login: web/diagrams/auth/login.md
- Refresh Token: web/diagrams/auth/refresh-token.md
- Confirm User: web/diagrams/auth/confirm-user.md
- Resend Confirmation: web/diagrams/auth/resend-confirmation.md
- Update Username: web/diagrams/auth/update-username.md
- Update Email: web/diagrams/auth/update-email.md
- Update Password: web/diagrams/auth/update-password.md
- Update Profile: web/diagrams/auth/update-profile.md
- Delete Account: web/diagrams/auth/delete-account.md
- Error Handling: web/diagrams/auth/error-handling.md
- Pipeline:
- Overview: pipeline/README.md
- Roadmap: pipeline/ROADMAP.md
- Ethics & Known Issues: pipeline/ETHICS-AND-KNOWN-ISSUES.md
- Diagrams:
- Current:
- Activity: pipeline/diagrams/current/activity.md
- Class: pipeline/diagrams/current/class.md
- Planned:
- Activity: pipeline/diagrams/planned/activity.md
- Class: pipeline/diagrams/planned/class.md
plugins:
- search
- glightbox
- panzoom:
mermaid: true
- minify:
minify_html: true
minify_js: true
minify_css: true
htmlmin_opts:
remove_comments: true
cache_safe: true
markdown_extensions:
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets:
base_path: [docs]
check_paths: true