Compare commits

...

6 Commits

Author SHA1 Message Date
Brian 7cc6ed0501
Merge branch 'main' into docs/style-guide-llm-optimization 2026-01-15 10:55:21 +08:00
Alex Verkhovsky 205bc438cb docs: address PR review findings for style guide
- Fix forward reference in Header Budget section
- Clarify descriptions rule scope (tables and 5+ item lists)
- Restore realistic FAQ examples
- Add qualifier to admonition content length guideline

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-13 14:34:48 -08:00
Alex Verkhovsky f92e465cd6 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>
2026-01-13 12:18:45 -08:00
Alex Verkhovsky 2a771d7722 docs: clarify header budget vs structure template relationship
Add note explaining that structure templates show content flow, not 1:1
header mapping. Admonitions and inline elements are within sections.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-13 12:14:21 -08:00
Alex Verkhovsky c5316c3f2f docs: clarify explanation checklist admonition limit
Disambiguate 2-3 admonitions max to explicitly show it is a per-document
limit that still respects the universal per-section rule.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-13 12:07:16 -08:00
Alex Verkhovsky 1702b07d6c docs: optimize style guide for LLM readers
Restructure documentation style guide with dependency-first ordering
and LLM-optimized content based on editorial-review-structure analysis.

Key changes:
- Add Universal Formatting Rules section at top (consolidated anti-patterns)
- Move Visual Hierarchy and formatting rules before document types
- Add Document Types decision table for type selection
- Move Before/After example to follow Visual Hierarchy
- Merge Links/Images into single Assets table
- Move tutorial-specific checklist into Tutorial Structure section
- Move Validation Steps to end (submission workflow)
- Cut abstract Quick Principles (no execution value for LLMs)
- Remove emotional/orientation language throughout
- Condense FAQ Sections structure

Result: ~35% reduction (539 deletions, 383 insertions) with improved
parseability for AI agents writing documentation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-13 11:09:14 -08:00
1 changed files with 543 additions and 713 deletions

File diff suppressed because it is too large Load Diff