Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
57 lines (46 loc) · 2.71 KB

DOCUMENTATION.md

File metadata and controls

57 lines (46 loc) · 2.71 KB
Raw

Documentation Structure

This file describes how docs are organized in this repository.

Repository-level docs

  • README.md - Main entry point for users
  • CHANGELOG.md - Release history
  • CONTRIBUTING.md - Contribution workflow
  • SECURITY.md - Security reporting policy
  • AGENTS.md - AI agent instructions for this codebase

docs/ (site + user/developer guides)

docs/
├── _config.yml                         # docs site config
├── DOCUMENTATION.md                    # this repository documentation map
├── README.md                           # docs portal / navigation
├── index.md                            # documentation landing page
├── architecture.md                     # public architecture overview
├── getting-started.md                  # install + first-run guide
├── tools-and-cli.md                    # 24 codex-* tools + standalone CLI
├── configuration.md                    # full config reference
├── troubleshooting.md                  # operational debugging guide
├── faq.md                              # short common answers
├── privacy.md                          # data handling notes
├── OPENCODE_PR_PROPOSAL.md             # upstream OpenCode proposal notes
└── development/
    ├── ARCHITECTURE.md                 # technical design and current module/docs layout
    ├── GITHUB_DISCOVERABILITY.md       # repository description, topics, and search terms
    ├── CONFIG_FIELDS.md                # config field semantics
    ├── CONFIG_FLOW.md                  # config resolution internals
    ├── TESTING.md                      # testing strategy and commands
    └── TUI_PARITY_CHECKLIST.md         # auth dashboard UI parity checks

config/ (copy-paste templates)

  • config/opencode-modern.json - OpenCode v1.0.210+ variant-based template (12 bases / 53 variants)
  • config/opencode-legacy.json - OpenCode v1.0.209 and below template (53 explicit entries)
  • config/minimal-opencode.json - minimal debug template
  • config/README.md - template-selection guide and install modes

Nested agent guides

  • lib/AGENTS.md - runtime module map
  • lib/tools/AGENTS.md - per-tool factory pattern for the codex-* registry
  • test/AGENTS.md - test-suite conventions

Notes

  • dist/ is build output and not a documentation source of truth.
  • For user-facing guidance, start with README.md, docs/getting-started.md, docs/tools-and-cli.md, or docs/architecture.md.
  • Documentation claims that mirror runtime behavior (tool counts, config keys, model catalog sizes, storage paths, internal links) are pinned by test/doc-parity.test.ts. Update the docs and that test together.