data-ai-chatbot/mkdocs.yml at dev · worldbank/data-ai-chatbot · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
site_name: Data AI Chatbot documentation
site_description: >-
  Data AI Chatbot — a self-hostable data chatbot powered by MCP, with optional Proof-Carrying Numbers.
  These docs focus on Data360 Chat, the World Bank reference configuration (Data360 MCP).
# Must match the GitHub Pages URL (repo name = first path segment for project pages).
site_url: https://avsolatorio.github.io/data-ai-chatbot/
repo_url: https://github.com/avsolatorio/data-ai-chatbot
edit_uri: edit/main/docs/

# Draft / internal Markdown in docs/ that should not be published (avoids link-check noise).
# Pin the doc toolchain: mkdocs>=1.6,<2 (MkDocs 2.x is not compatible with Material yet).
exclude_docs: |
  architecture-data360-chat.md
  architecture/Data360-Chat-Architecture.docx
  architecture/generate_docx.py
  database-idempotency-and-duplicate-inserts.md
  itsda-data360-chat-int-fe-diff-integration.md
  open-source-application.md
  plan-remove-frontend-db-dependency.md
  pr-feat-*.md
  pr-fix-*.md
  security-guardrails-audit.md
  security/guardrails-audit.md
  single-llm-thinking-transition.md
  task-workflow.md

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - search.suggest
    - search.highlight
  palette:
    - scheme: default
      primary: blue
    - scheme: slate
      primary: blue

plugins:
  - search

markdown_extensions:
  - pymdownx.superfences
  - pymdownx.tabbed
  - admonition
  - pymdownx.details

nav:
  - Home: index.md
  - User Guide:
    - user-guide/index.md
    - user-guide/getting-started.md
    - user-guide/chat-features.md
    - user-guide/documents-spreadsheets.md
    - user-guide/data-analysis.md
    - user-guide/file-attachments.md
    - user-guide/chat-visibility.md
    - user-guide/faq.md
  - Architecture:
    - architecture/index.md
    - architecture/overview.md
    - architecture/system-context.md
    - architecture/backend.md
    - architecture/frontend.md
    - architecture/data-persistence.md
    - architecture/authentication.md
    - architecture/ai-streaming.md
    - architecture/integrations.md
    - architecture/deployment-and-operations.md
    - architecture/architectural-decisions.md
  - Infrastructure:
    - infrastructure/index.md
    - infrastructure/components.md
    - infrastructure/network-topology.md
    - infrastructure/data-flow.md
  - Deployment:
    - deployment/index.md
    - deployment/local-development.md
    - deployment/docker.md
    - "Docker setup (detailed)": docker-setup.md
    - deployment/production.md
    - deployment/deployment-rendering.md
  - Operations:
    - operations/index.md
    - operations/environment-variables.md
    - operations/health-monitoring.md
    - operations/logging.md
    - operations/troubleshooting.md
    - operations/runbooks.md
  - Security:
    - security/index.md
    - security/overview.md
    - security/risk-assessment.md
  - Admin Guide:
    - admin-guide/index.md
    - admin-guide/feedback-review.md
    - admin-guide/maintenance-mode.md
    - admin-guide/user-management.md
  - API:
    - api/index.md