- Add complete API documentation and architecture guides - Include quick start, installation, and deployment guides - Add troubleshooting and security documentation - Include CLI reference and configuration schema docs - Add production monitoring and operations guides - Implement MkDocs configuration with search functionality - Include comprehensive user and developer documentation Provides complete documentation for users and developers covering all aspects of the FetchML platform.
71 lines
1.4 KiB
YAML
71 lines
1.4 KiB
YAML
site_name: Fetch ML Documentation
|
|
site_description: Secure Machine Learning Platform
|
|
repo_url: https://github.com/jfraeys/fetch_ml
|
|
edit_uri: edit/main/docs/
|
|
|
|
docs_dir: src
|
|
site_dir: _site
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- quick-start.md
|
|
- installation.md
|
|
- first-experiment.md
|
|
- Development:
|
|
- development-setup.md
|
|
- testing.md
|
|
- architecture.md
|
|
- cli-reference.md
|
|
- zig-cli.md
|
|
- queue.md
|
|
- smart-defaults.md
|
|
- cicd.md
|
|
- Operations & Production:
|
|
- deployment.md
|
|
- environment-variables.md
|
|
- production-monitoring.md
|
|
- operations.md
|
|
- redis-ha.md
|
|
- release-checklist.md
|
|
- Security:
|
|
- security.md
|
|
- api-key-process.md
|
|
- user-permissions.md
|
|
- Reference:
|
|
- configuration-schema.md
|
|
- troubleshooting.md
|
|
|
|
theme:
|
|
name: material
|
|
palette:
|
|
- scheme: default
|
|
primary: blue
|
|
accent: blue
|
|
- scheme: slate
|
|
primary: blue
|
|
accent: blue
|
|
font:
|
|
text: Roboto
|
|
code: Roboto Mono
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.indexes
|
|
- toc.integrate
|
|
- search.highlight
|
|
- search.share
|
|
|
|
plugins:
|
|
- search
|
|
|
|
markdown_extensions:
|
|
- codehilite
|
|
- admonition
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.superfences
|
|
- pymdownx.highlight
|