agentic-ai-solution-accelerator/mkdocs.yml at main · Azure-Samples/agentic-ai-solution-accelerator · 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
149
150
151
152
153
154
155
156
site_name: Agentic AI Solution Accelerator
site_description: Partner guide for delivering agentic AI solutions to SMB customers on Microsoft Agent Framework + Microsoft Foundry.
site_url: https://azure-samples.github.io/agentic-ai-solution-accelerator/
repo_url: https://github.com/Azure-Samples/agentic-ai-solution-accelerator
repo_name: Azure-Samples/agentic-ai-solution-accelerator
edit_uri: edit/main/docs/
docs_dir: docs-build
site_dir: site

# Validation -- promote link/anchor drift to warnings so `mkdocs build --strict`
# catches them in CI. Default mkdocs only validates nav files; anchors are info-only
# unless we explicitly raise them. This is what lets prepare-pages + strict together
# enforce that a partner's edits to docs/ don't silently break Pages anchors.
validation:
  nav:
    omitted_files: info
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    absolute_links: warn
    unrecognized_links: warn
    anchors: warn

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.suggest
    - search.highlight
    - content.tooltips
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - include-markdown

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - Get ready:
      - start/ready/01-get-oriented.md
      - start/ready/02-set-up-your-machine.md
      - start/ready/03-rehearse-in-a-sandbox.md
  - Deliver to a customer:
      - start/deliver/01-clone-for-the-customer.md
      - start/deliver/02-discover-with-the-customer.md
      - start/deliver/03-scaffold-from-the-brief.md
      - start/deliver/04-provision-the-customers-azure.md
      - start/deliver/05-iterate-and-evaluate.md
      - start/deliver/06-uat-and-handover.md
      - start/deliver/07-operate-day-2.md
  - Reference:
      - Architecture & governance:
          - Reference architecture: patterns/architecture/README.md
          - Azure AI landing zone: patterns/azure-ai-landing-zone/README.md
          - WAF alignment: patterns/waf-alignment/README.md
          - Responsible AI: patterns/rai/README.md
      - Engineering reference:
          - Agent specs: agent-specs/README.md
          - Tool catalog: foundry-tool-catalog.md
          - Version matrix: version-matrix.md
      - Frontend starter: patterns/sales-research-frontend/README.md
      - Reference scenarios:
          - Customer service actioning: references/customer-service-actioning/README.md
          - RFP response: references/rfp-response/README.md
      - Chatmodes:
          - Overview: chatmodes-index.md
          - Delivery guide: chatmodes/delivery-guide.chatmode.md
          - Discover scenario: chatmodes/discover-scenario.chatmode.md
          - Ingest PRD: chatmodes/ingest-prd.chatmode.md
          - Scaffold from brief: chatmodes/scaffold-from-brief.chatmode.md
          - Configure landing zone: chatmodes/configure-landing-zone.chatmode.md
          - Deploy to environment: chatmodes/deploy-to-env.chatmode.md
          - Add tool: chatmodes/add-tool.chatmode.md
          - Add worker agent: chatmodes/add-worker-agent.chatmode.md
          - Switch to variant: chatmodes/switch-to-variant.chatmode.md
          - Explain change: chatmodes/explain-change.chatmode.md
      - Delivery deep dives:
          - Partner playbook: partner-playbook.md
          - Workflow map: partner-workflow.md
          - Solution brief guide: discovery/SOLUTION-BRIEF-GUIDE.md
          - Discovery deep flow: discovery/how-to-use.md
          - Handover template: handover/handover-packet-template.md
          - Sandbox lab guide: enablement/hands-on-lab.md
          - Day-2 runbook: customer-runbook.md
          - Quickstart cheat-sheet: QUICKSTART.md
          - Setup & prereqs deep: getting-started/setup-and-prereqs.md
  - About:
      - Support: about/SUPPORT.md
      - Contributing: about/CONTRIBUTING.md
      - Security: about/SECURITY.md
      - CLA: about/CLA.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Azure-Samples/agentic-ai-solution-accelerator

extra_css:
  - stylesheets/extra.css

copyright: Copyright &copy; Microsoft Corporation.