This repo defines a lightweight, in-repo documentation system for both humans and AI agents. You are likely here to modify the system spec, add automation scripts, update workflows, or extend the frontmatter schema. The index below lists all available documentation. Read the description column for each row and load only the docs that are relevant to your current task.
Load a doc if its description matches the concepts, components, or tasks involved in your current work. The description field is written as a trigger condition: "Load when [conditions]." If the conditions match your task, load the doc. If they do not, skip it.
If no doc in the index is relevant to your task, proceed without loading any. The absence of a relevant doc is useful signal — it may mean the area you are working in is undocumented. Note this if it affects your ability to complete the task accurately.
| Doc | When to load | Last validated | Status | Paths |
|---|---|---|---|---|
| AGENTS.md structure | Load when editing AGENTS.md preamble, modifying the index table format, or updating build-index.py. | 2026-03-12 | stale (paths) | AGENTS.mdscripts/agents/build-index.py |
| Automation workflow | Load when modifying GitHub Actions workflows, debugging CI runs, or changing staleness detection logic. | 2026-03-12 | stale (paths) | .github/workflows/**scripts/agents/** |
| Frontmatter schema | Load when authoring new docs, reviewing frontmatter validation, or modifying the build-index script. | 2026-03-12 | stale (paths) | docs/**scripts/agents/build-index.py.agentsrc.yaml |
| Get started | Load when setting up code-docs in a new repo, migrating existing docs to use frontmatter, or troubleshooting initial configuration. | 2026-03-28 | current | |
| How it works | Load when evaluating code-docs for adoption, onboarding to the system, or seeking an end-to-end understanding of the documentation lifecycle. | 2026-03-28 | current | |
| LLM prompt design (provider-agnostic) | Load when implementing a provider-agnostic LLM layer or porting frontmatter generation to non-Claude providers. | 2026-03-12 | current | |
| LLM prompt design for Claude Code | Load when modifying the Claude Code task prompt, adjusting CI frontmatter generation, or debugging LLM output. | 2026-03-12 | stale (paths) | .github/agents/**.github/workflows/docs-sync.yml |