KnowCode/mkdocs.yml at main · deepakdgupta1/KnowCode · GitHub

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
site_name: KnowCode Documentation
site_url: https://example.com/knowcode/
repo_url: https://github.com/deepakdgupta1/KnowCode
repo_name: deepakdgupta1/KnowCode
edit_uri: edit/main/docs/

# Superseded docs are kept for history but excluded from the built site.
exclude_docs: archive/*

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            heading_level: 2

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - attr_list

nav:
  - Home: index.md
  - User Guide:
      - Getting Started: user/getting-started.md
      - CLI Reference: user/cli-reference.md
      - Configuration: user/configuration.md
      - IDE & Agent Integration: user/ide-integration.md
      - REST API: user/rest-api.md
      - Telemetry & Privacy: user/telemetry.md
  - Product:
      - Overview: product/overview.md
      - Personas & Use-Cases: product/personas-use-cases.md
      - Business Logic: product/business-logic.md
  - Roadmap: roadmap.md
  - MCP Contract: mcp-contract.md
  - Engineering:
      - Architecture: engineering/architecture.md
      - ADR Index: engineering/adr/index.md
      - Internals:
          - Indexing & Generations: engineering/internals/indexing-generations.md
          - Retrieval & Synthesis: engineering/internals/retrieval-synthesis.md
          - Storage Formats: engineering/internals/storage-formats.md
      - Parser Matrix: engineering/parser-matrix.md
      - Source API Reference: engineering/api-source.md
      - Testing & Evaluation: engineering/testing.md
      - Release Checklist: engineering/release.md
  - Workflow Diagrams: diagrams/README.md
  - Research:
      - Prose Evaluation: research/knowcode_evaluation_report.md
      - Architecture Synthesis (50M+ LOC): research/knowcode-architecture-synthesis.md
      - Document Collateral Retrieval: research/document_collateral_retrieval_2026.md