docs

Firewood Documentation

Complete documentation for the Firewood project.

Structure

📂 bugs/

Bug fix documentation with detailed reports and analysis.

• BUGFIX_*.md - Individual bug fix reports
• See bugs/README.md for template and guidelines

📂 design/

Technical design and implementation documentation.

• Design specifications
• Implementation details
• Architecture documentation
• Provider and feature documentation

📂 templates/

Reusable documentation templates.

• design.md - Design document template
• See templates/README.md for usage guide

📂 testing/

Testing infrastructure and documentation.

• Pytest setup and configuration
• Test status and coverage reports
• Testing guidelines

📂 project/

Project-level documentation and external integrations.

• FLAME_INTEGRATION.md - Integration with Flame framework
• Project relationships and architecture

📂 meta/

Meta-documentation about Firewood's documentation.

• Documentation organization guides
• Reorganization history
• Project summaries

📂 tutorials/

Step-by-step guides for using Firewood features.

• feishu_bridge.md - Connect to Feishu/Lark chat
• See tutorials/README.md for full list

Root Documentation

Essential user-facing documentation stays in the root directory:

File	Purpose
README.md	Main user documentation and getting started
QUICKSTART.md	5-minute setup guide
SLOGAN.md	Project slogan and branding
ABOUT_FIREWOOD.md	Project overview and philosophy
CHANGELOG.md	Version history and changes
AGENTS.md	AI coding agent guidance

Finding Documentation

For Users

Start with root documentation:

1. ../README.md - Overview and getting started
2. ../QUICKSTART.md - Quick setup
3. ../ABOUT_FIREWOOD.md - Project details

For Contributors

• design/ - Technical implementation
• bugs/ - Bug fix history
• testing/ - How to test
• templates/ - Documentation templates
• ../AGENTS.md - Complete contributor guide

For Understanding Organization

• meta/DOCS_ORGANIZATION.md - Complete organization guide
• meta/ - Documentation history and summaries

Documentation Guidelines

Where to Put New Documentation

Type	Location	Example
User guide	Root	README.md
Design doc	docs/design/	PROVIDER_IMPLEMENTATION.md
Bug fix	docs/bugs/	BUGFIX_CONFIG_SAVE.md
Testing	docs/testing/	PYTEST_SETUP.md
Project overview	docs/project/	FLAME_INTEGRATION.md
Tutorial	docs/tutorials/	feishu_bridge.md
Meta-doc	docs/meta/	DOCS_ORGANIZATION.md
Template	docs/templates/	design.md

Key Principles

✅ Do:

• Keep root minimal (only user-facing docs)
• Use appropriate subdirectories
• Follow existing templates
• Add README files for new directories

❌ Don't:

• Clutter root with technical docs
• Create docs without clear purpose
• Duplicate information
• Skip templates

Related Files

• AGENTS.md (root) - Complete guidance for AI agents
• meta/DOCS_ORGANIZATION.md - Detailed organization guide
• templates/ - Templates for new docs

---

Last Updated: 2026-02-01
Maintained By: Contributors