mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-10-19 09:54:16 +00:00
32 lines
915 B
Markdown
32 lines
915 B
Markdown
# Documentation Style Guide
|
|
|
|
## Source of Truth
|
|
|
|
**Primary style guide** (READ THIS FIRST):
|
|
|
|
- `docs/AGENTS.md` - Complete documentation style guide including brand voice, formatting standards, SEO rules, and writing conventions
|
|
|
|
## Additional Resources
|
|
|
|
For technical documentation setup:
|
|
|
|
- `docs/developer-guide/documentation.mdx` - Mintlify-based documentation and local development setup
|
|
|
|
## Contents
|
|
|
|
The `docs/AGENTS.md` file covers:
|
|
- Prowler's brand voice
|
|
- Unbiased communication guidelines
|
|
- Naming conventions (Prowler features as proper nouns)
|
|
- Verbal vs nominal constructions
|
|
- Title-case capitalization rules
|
|
- Hyphenation patterns
|
|
- Bullet point formatting and punctuation
|
|
- Quotation mark usage
|
|
- Interaction verbs (click, tap, etc.)
|
|
- SEO optimization (sentence structure, headers)
|
|
- Section titles and headers
|
|
- Version badge usage
|
|
- Warnings and danger calls
|
|
- Technical writing best practices
|