ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

docs: remove horizontal rules to follow own guidelines 

Remove all --- section separators to comply with Universal Formatting
Rules. The ## headers provide sufficient visual separation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Alex Verkhovsky 2026-01-13 12:18:45 -08:00
parent 1f859c2378
commit fbfbbb0f16
1 changed files with 0 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/_STYLE_GUIDE.md
View File

@ -215,8 +215,6 @@ your-project/
``` ```
```` ````
---
## Document Types ## Document Types
Select document type based on reader goal: Select document type based on reader goal:
@ -229,8 +227,6 @@ Select document type based on reader goal:
| Look up information | Reference | | Look up information | Reference |
| Find term definitions | Glossary | | Find term definitions | Glossary |
---
## Tutorial Structure ## Tutorial Structure
Tutorials teach complete workflows to new users. Length: 200-400 lines. Tutorials teach complete workflows to new users. Length: 200-400 lines.
@ -266,8 +262,6 @@ Tutorials teach complete workflows to new users. Length: 200-400 lines.
- [ ] Getting Help section present - [ ] Getting Help section present
- [ ] Key Takeaways admonition at end - [ ] Key Takeaways admonition at end
---
## How-To Structure ## How-To Structure
How-to guides complete specific tasks for users who know basics. Length: 50-150 lines (shorter than tutorials, assumes prior knowledge). How-to guides complete specific tasks for users who know basics. Length: 50-150 lines (shorter than tutorials, assumes prior knowledge).
@ -307,8 +301,6 @@ Guidelines:
- [ ] Steps are numbered `###` subsections with action verbs - [ ] Steps are numbered `###` subsections with action verbs
- [ ] "What You Get" describes output artifacts - [ ] "What You Get" describes output artifacts
---
## Explanation Structure ## Explanation Structure
Explanation documents answer "What is X?" and "Why does X matter?" Explanation documents answer "What is X?" and "Why does X matter?"
@ -396,8 +388,6 @@ Explanation documents answer "What is X?" and "Why does X matter?"
- [ ] Links to how-to guides for procedural questions - [ ] Links to how-to guides for procedural questions
- [ ] 2-3 admonitions max per document (1-2 per section) - [ ] 2-3 admonitions max per document (1-2 per section)
---
## Reference Structure ## Reference Structure
Reference documents answer "What are the options?" and "What does X do?" for users who know what they need. Reference documents answer "What are the options?" and "What does X do?" for users who know what they need.
@ -486,8 +476,6 @@ Guidelines:
- [ ] Links to explanation docs for conceptual depth - [ ] Links to explanation docs for conceptual depth
- [ ] 1-2 admonitions max - [ ] 1-2 admonitions max
---
## Glossary Structure ## Glossary Structure
Glossaries provide compact, scannable term definitions. Glossaries provide compact, scannable term definitions.
@ -559,8 +547,6 @@ Reference category anchor (terms are not headers):
- [ ] Term names bolded in cells - [ ] Term names bolded in cells
- [ ] No "A [term] is..." definitions - [ ] No "A [term] is..." definitions
---
## FAQ Sections ## FAQ Sections
Structure: Structure:
@ -588,8 +574,6 @@ Rules:
- Direct answers (no `**A:**` prefix) - Direct answers (no `**A:**` prefix)
- End with CTA for unanswered questions - End with CTA for unanswered questions
---
## Validation Steps ## Validation Steps
Before submitting documentation changes, run from repo root: Before submitting documentation changes, run from repo root: