@@ -6,17 +6,17 @@ This project adheres to the [Google Developer Documentation Style Guide](https:/
66
77## Project-Specific Rules
88
9- | Rule | Specification |
10- | ------| ---------------|
11- | No horizontal rules (` --- ` ) | Fragments reading flow |
12- | No ` #### ` headers | Use bold text or admonitions instead |
13- | No "Related" or "Next:" sections | Sidebar handles navigation |
14- | No deeply nested lists | Break into sections instead |
15- | No code blocks for non-code | Use admonitions for dialogue examples |
16- | No bold paragraphs for callouts | Use admonitions instead |
17- | 1-2 admonitions per section max | Tutorials allow 3-4 per major section |
18- | Table cells / list items | 1-2 sentences max |
19- | Header budget | 8-12 ` ## ` per doc; 2-3 ` ### ` per section |
9+ | Rule | Specification |
10+ | -------------------------------- | ---------------------------------------- |
11+ | No horizontal rules (` --- ` ) | Fragments reading flow |
12+ | No ` #### ` headers | Use bold text or admonitions instead |
13+ | No "Related" or "Next:" sections | Sidebar handles navigation |
14+ | No deeply nested lists | Break into sections instead |
15+ | No code blocks for non-code | Use admonitions for dialogue examples |
16+ | No bold paragraphs for callouts | Use admonitions instead |
17+ | 1-2 admonitions per section max | Tutorials allow 3-4 per major section |
18+ | Table cells / list items | 1-2 sentences max |
19+ | Header budget | 8-12 ` ## ` per doc; 2-3 ` ### ` per section |
2020
2121## Admonitions (Starlight Syntax)
2222
@@ -40,31 +40,31 @@ Critical warnings only — data loss, security issues
4040
4141### Standard Uses
4242
43- | Admonition | Use For |
44- | ------------| ---------|
45- | ` :::note[Prerequisites] ` | Dependencies before starting |
46- | ` :::tip[Quick Path] ` | TL;DR summary at document top |
47- | ` :::caution[Important] ` | Critical caveats |
48- | ` :::note[Example] ` | Command/response examples |
43+ | Admonition | Use For |
44+ | ------------------------ | ----------------------------- |
45+ | ` :::note[Prerequisites] ` | Dependencies before starting |
46+ | ` :::tip[Quick Path] ` | TL;DR summary at document top |
47+ | ` :::caution[Important] ` | Critical caveats |
48+ | ` :::note[Example] ` | Command/response examples |
4949
5050## Standard Table Formats
5151
5252** Phases:**
5353
5454``` md
55- | Phase | Name | What Happens |
56- | ------- | ------| --------------|
57- | 1 | Analysis | Brainstorm, research * (optional)* |
58- | 2 | Planning | Requirements — PRD or tech-spec * (required)* |
55+ | Phase | Name | What Happens |
56+ | ----- | -- ------ | -------------------------------------------- |
57+ | 1 | Analysis | Brainstorm, research * (optional)* |
58+ | 2 | Planning | Requirements — PRD or tech-spec * (required)* |
5959```
6060
6161** Commands:**
6262
6363``` md
64- | Command | Agent | Purpose |
65- | ---------| -------| ---------|
66- | ` *workflow-init ` | Analyst | Initialize a new project |
67- | ` * prd` | PM | Create Product Requirements Document |
64+ | Command | Agent | Purpose |
65+ | ------------ | ------- | ------------------------------------ |
66+ | ` brainstorm ` | Analyst | Brainstorm a new project |
67+ | ` prd ` | PM | Create Product Requirements Document |
6868```
6969
7070## Folder Structure Blocks
@@ -141,13 +141,13 @@ your-project/
141141
142142### Types
143143
144- | Type | Example |
145- | ------| ---------|
146- | ** Index/Landing** | ` core-concepts/index.md ` |
147- | ** Concept** | ` what-are-agents.md ` |
148- | ** Feature** | ` quick-flow.md ` |
149- | ** Philosophy** | ` why-solutioning-matters.md ` |
150- | ** FAQ** | ` brownfield-faq.md ` |
144+ | Type | Example |
145+ | ----------------- | ---------------------------- |
146+ | ** Index/Landing** | ` core-concepts/index.md ` |
147+ | ** Concept** | ` what-are-agents.md ` |
148+ | ** Feature** | ` quick-flow.md ` |
149+ | ** Philosophy** | ` why-solutioning-matters.md ` |
150+ | ** FAQ** | ` brownfield-faq.md ` |
151151
152152### General Template
153153
@@ -217,14 +217,14 @@ your-project/
217217
218218### Types
219219
220- | Type | Example |
221- | ------| ---------|
222- | ** Index/Landing** | ` workflows/index.md ` |
223- | ** Catalog** | ` agents/index.md ` |
224- | ** Deep-Dive** | ` document-project.md ` |
225- | ** Configuration** | ` core-tasks.md ` |
226- | ** Glossary** | ` glossary/index.md ` |
227- | ** Comprehensive** | ` bmgd-workflows.md ` |
220+ | Type | Example |
221+ | ----------------- | --------------------- |
222+ | ** Index/Landing** | ` workflows/index.md ` |
223+ | ** Catalog** | ` agents/index.md ` |
224+ | ** Deep-Dive** | ` document-project.md ` |
225+ | ** Configuration** | ` core-tasks.md ` |
226+ | ** Glossary** | ` glossary/index.md ` |
227+ | ** Comprehensive** | ` bmgd-workflows.md ` |
228228
229229### Reference Index Pages
230230
@@ -303,19 +303,19 @@ Starlight generates right-side "On this page" navigation from headers:
303303``` md
304304## Category Name
305305
306- | Term | Definition |
307- | ------| ------------|
308- | ** Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
306+ | Term | Definition |
307+ | ------------ | ---------------------------------------------------------------------------------------- |
308+ | ** Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
309309| ** Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. |
310310```
311311
312312### Definition Rules
313313
314- | Do | Don't |
315- | ----| -------|
314+ | Do | Don't |
315+ | ----------------------------- | ------------------------------------------- |
316316| Start with what it IS or DOES | Start with "This is..." or "A [ term] is..." |
317- | Keep to 1-2 sentences | Write multi-paragraph explanations |
318- | Bold term name in cell | Use plain text for terms |
317+ | Keep to 1-2 sentences | Write multi-paragraph explanations |
318+ | Bold term name in cell | Use plain text for terms |
319319
320320### Context Markers
321321
0 commit comments