sql_env / docs /README.md
hjerpe's picture
Upload folder using huggingface_hub
5dd1bb4 verified

Docs

This directory is the system-of-record for durable project knowledge.

Quick Links

Category Index Type Purpose
Guides guides/README.md how-to Practical step-by-step procedures
Design design-docs/index.md explanation Feature design, ADRs, decision rationale
ADR Template design-docs/decisions/0001-template.md reference Decision record template
References references/README.md reference External docs for agent context

System Docs

Directory Structure

docs/
β”œβ”€β”€ README.md                    # This file (index)
β”œβ”€β”€ ARCHITECTURE.md              # System design overview [reference]
β”œβ”€β”€ RUNBOOK.md                   # Operations guide [how-to]
β”œβ”€β”€ guides/                      # How-to guides [how-to]
β”‚   └── README.md                # Guide index
β”œβ”€β”€ design-docs/                 # Decision rationale [explanation]
β”‚   β”œβ”€β”€ index.md                 # Design docs catalogue
β”‚   └── decisions/               # Architectural Decision Records
└── references/                  # External docs [reference]
    └── README.md                # External docs for agent context

Adding Documentation

If you need... Create in... Type
Step-by-step procedure docs/guides/<topic>.md how-to
Design for a feature docs/design-docs/<feature>.md explanation
External library docs docs/references/<library>-llms.txt reference