Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,33 @@ theme:
plugins:
- search
- tags
- llmstxt-md:
sections:
Getting Started:
- getting-started/index.md: "Introduction to runqy"
- getting-started/installation.md: "Installation methods (CLI, Docker, source)"
- getting-started/quickstart.md: "Quick start guide with Docker Compose"
- getting-started/architecture.md: "Architecture overview and concepts"
Server:
- server/index.md: "Server overview"
- server/configuration.md: "Server configuration reference"
- server/cli.md: "CLI commands reference"
- server/api.md: "REST API reference (enqueue, batch, task status)"
Worker:
- worker/index.md: "Worker overview"
- worker/configuration.md: "Worker configuration reference"
- worker/deployment.md: "Deployment and bootstrap process"
Python SDK:
- python-sdk/index.md: "Python SDK overview"
- python-sdk/installation.md: "SDK installation"
- python-sdk/decorators.md: "Task decorators (@task, @load)"
- python-sdk/examples.md: "Code examples"
Guides:
- guides/local-development.md: "Local development setup"
- guides/enqueueing-tasks.md: "How to enqueue tasks"
- guides/result-delivery.md: "Getting task results"
- guides/vaults.md: "Secrets management with Vaults"
- guides/monitoring.md: "Monitoring and metrics"

markdown_extensions:
- pymdownx.emoji:
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
mkdocs>=1.5.0
mkdocs-material>=9.5.0
mkdocs-llmstxt-md>=0.1.0