forked from dataseeek/MagesticAI
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
58 lines (52 loc) · 1.99 KB
/
Copy pathmkdocs.yml
File metadata and controls
58 lines (52 loc) · 1.99 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# MkDocs config for Backstage TechDocs.
# Built automatically by Backstage on view, and validated in CI by
# .github/workflows/techdocs.yml. The OpenAPI spec + dependencies page are
# regenerated by that workflow so the docs never drift.
# https://backstage.io/docs/features/techdocs/getting-started
site_name: AIFactory
site_description: Spec-Driven Development for AI agents — plan, code, ship. Web-based platform that turns GitHub issues into shipping code via a planner / coder / QA agent pipeline.
docs_dir: docs
plugins:
- techdocs-core
# Render ```mermaid fenced blocks in Backstage TechDocs (the diagrams in
# concepts/pipeline-flow.md). techdocs-core bundles pymdownx; the Backstage
# mermaid addon turns the preserved fence into a rendered diagram.
markdown_extensions:
- md_in_html
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# docs_dir points at the Docusaurus project, which carries a huge node_modules
# tree (~1900 markdown files) plus Docusaurus-only sources (.mdx, blog, src).
# Excluding them keeps the TechDocs build fast (~8s vs a 3-min timeout) and
# clean — only the real documentation is published.
exclude_docs: |
node_modules/
build/
.docusaurus/
blog/
src/
plans/
"*.mdx"
docusaurus.config.ts
sidebars.ts
package.json
package-lock.json
README.md
# Curated navigation (paths are relative to docs_dir). The Docusaurus content
# lives under docs/docs/; the home + generated pages sit at the docs/ root.
nav:
- Home: index.md
- Overview: docs/intro.md
- Why AIFactory: docs/why-aifactory.md
- Getting Started: docs/getting-started.md
- Architecture: docs/architecture/overview.md
- Pipeline Flow: docs/concepts/pipeline-flow.md
- Task Lifecycle: docs/task-lifecycle.md
- Task Contract v2: docs/task-contract.md
- API Reference: api.md
- Dependencies: dependencies.md
- Roadmap: docs/roadmap.md
- Contributing: docs/contributing.md