dazzle/mkdocs.yml at main · manwithacat/dazzle · 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
site_name: Dazzle Developer Docs
site_description: Developer documentation for Dazzle - DSL-first toolkit for building apps from high-level specifications.
site_url: https://manwithacat.github.io/dazzle/
repo_url: https://github.com/manwithacat/dazzle
repo_name: manwithacat/dazzle
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.action.edit
    - content.action.view
    - content.code.copy
    - search.highlight
    - search.share
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Start Here: index.md
  - Getting Started:
      - Overview: getting-started/index.md
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
      - Your First App: getting-started/first-app.md
  - Architecture:
      - Overview: architecture/overview.md
      - Event Semantics: architecture/event-semantics.md
      - HLESS Deep Dive: architecture/hless-deep-dive.md
      - DSL to AppSpec: architecture/dsl-to-appspec.md
      - MCP Server: architecture/mcp-server.md
  - DSL Reference:
      - Overview: reference/index.md
      - Entities: reference/entities.md
      - Access Control: reference/access-control.md
      - Surfaces: reference/surfaces.md
      - Workspaces: reference/workspaces.md
      - UX Layer: reference/ux.md
      - Experiences: reference/experiences.md
      - Services: reference/services.md
      - Integrations: reference/integrations.md
      - Processes: reference/processes.md
      - Stories: reference/stories.md
      - Rhythms: reference/rhythms.md
      - Ledgers: reference/ledgers.md
      - Graphs: reference/graphs.md
      - LLM Models & Intents: reference/llm.md
      - Compliance: reference/compliance.md
      - RBAC Verification: reference/rbac-verification.md
      - Testing: reference/testing.md
      - Frontend & Templates: reference/frontend.md
      - Messaging: reference/messaging.md
      - Governance: reference/governance.md
      - Patterns: reference/patterns.md
      - Scenarios: reference/scenarios.md
      - Runtime Capabilities: reference/runtime-capabilities.md
      - HTMX Templates: reference/htmx-templates.md
      - Databases: reference/databases.md
      - Deployment: reference/deployment.md
      - Islands: reference/islands.md
      - PII & Privacy: reference/pii-privacy.md
      - CLI: reference/cli.md
      - Grammar: reference/grammar.md
  - Guides:
      - Heroku Deployment: guides/heroku.md
      - Operations: guides/operations.md
      - Scaling: guides/scaling.md
  - Examples:
      - Overview: examples/index.md
      - Simple Task: examples/simple-task.md
      - Contact Manager: examples/contact-manager.md
      - Support Tickets: examples/support-tickets.md
      - Ops Dashboard: examples/ops-dashboard.md
      - FieldTest Hub: examples/fieldtest-hub.md
  - Contributing:
      - Dev Setup: contributing/dev-setup.md
      - Testing: contributing/testing.md
      - Adding a Feature: contributing/adding-a-feature.md
  - API Reference:
      - Overview: api-reference/index.md
      - dazzle: api-reference/modules/dazzle.md
      - dazzle_back: api-reference/modules/dazzle_back.md
      - dazzle_ui: api-reference/modules/dazzle_ui.md
  - ADRs:
      - "0001: Docs Site": adr/0001-docs-site.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

exclude_docs: |
  superpowers/
  proposals/

plugins:
  - search

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/manwithacat/dazzle