DataLex/mkdocs.yml at main · duckcode-ai/DataLex · 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
102
103
104
105
106
107
108
109
110
111
112
113
site_name: DataLex
site_description: AI-first dbt adoption, contracts, diagrams, and manifest publishing.
site_url: https://datalex.duckcode.ai
repo_url: https://github.com/duckcode-ai/DataLex
repo_name: duckcode-ai/DataLex
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.tabs.link
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.snippets

plugins:
  - search
  - awesome-pages

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/duckcode-ai/DataLex
    - icon: fontawesome/brands/discord
      link: https://discord.gg/Dnm6bUvk
  version:
    provider: mike
    default: stable

# Ignore archive + working artifacts in the published site.
exclude_docs: |
  archive/
  launch/
  rfcs/0000-template.md

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Tutorials:
      - Overview: tutorials/index.md
      - 1. Install and run: tutorials/01-install-and-run.md
      - 2. Connect dbt: tutorials/02-connect-existing-dbt.md
      - 3. Configure AI: tutorials/03-configure-ai.md
      - 4. Generate and certify: tutorials/04-generate-review-certify.md
      - 5. Publish manifest: tutorials/05-publish-manifest.md
      - 6. Docker: tutorials/06-docker.md
  - Concepts:
      - Enterprise OSS workflow: enterprise-oss-workflow.md
      - AI-agentic modeling: ai-agentic-modeling.md
      - Layered model and layout: datalex-layout.md
      - Optional DataLex + DQL stack: datalex-and-dql.md
      - Contracts for DQL blocks: contracts-for-dql-blocks.md
      - Data mesh interfaces: mesh-interfaces.md
      - Architecture: architecture.md
  - Reference:
      - CLI: cli.md
      - API contracts: api-contracts.md
  - Manifest spec:
      - Overview: manifest-spec/index.md
      - Interop (datalex_contract resolution rules): manifest-spec/interop.md
      - Versioning policy: manifest-spec/versioning.md
      - Changelog: manifest-spec/CHANGELOG.md
  - Operations:
      - Observability SLOs: observability-slos.md
      - Backup & restore runbook: backup-restore-runbook.md
  - Community:
      - Contributing: https://github.com/duckcode-ai/DataLex/blob/main/CONTRIBUTING.md
      - Roadmap: https://github.com/duckcode-ai/DataLex/blob/main/ROADMAP.md
      - Support & triage: https://github.com/duckcode-ai/DataLex/blob/main/SUPPORT.md
      - Manifest spec: https://github.com/duckcode-ai/manifest-spec