AGENTS.md - Documentation

Overview

Project documentation, guides, and reference materials.

Setup & environment

• Documentation may use a static site generator
• Preview locally before committing major changes
• Check for broken links and formatting issues

Documentation structure

• README.md - Entry point, project overview
• getting-started/ - Installation and quick start guides
• guides/ - How-to guides and tutorials
• reference/ - API documentation, configuration reference
• architecture/ - Design documents, ADRs
• contributing/ - Contribution guidelines

Code style & conventions

• Use clear, concise language
• Include code examples for technical concepts
• Keep line length reasonable (~80-120 chars)
• Use consistent heading hierarchy
• Add alt text to images for accessibility
• Use relative links for internal references
• Keep code examples up-to-date with actual codebase

Markdown best practices

• Use fenced code blocks with language hints
• Use tables for structured data comparison
• Keep paragraphs focused on one idea
• Use bullet points for lists, numbered lists for sequences

Security & safety

• Never include secrets, API keys, or credentials in examples
• Use placeholder values
• Review screenshots for sensitive information
• Avoid documenting security vulnerabilities in detail