From 635e4ebd90bfa1c2950ff24c5281ccdf8f73e4d7 Mon Sep 17 00:00:00 2001 From: "Derek Palmer (Creative)" Date: Tue, 9 Jun 2026 17:49:58 -0400 Subject: [PATCH] docs(context): define Docs Index term MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Glossary support for #105 — README documentation index feature. readme task is sole writer; check flags unlinked or dead-linked docs. --- CONTEXT.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTEXT.md b/CONTEXT.md index d245941..06177e4 100644 --- a/CONTEXT.md +++ b/CONTEXT.md @@ -40,6 +40,10 @@ _Avoid_: npm pack script, file list check The approval step in an interactive refresh where the agent presents the staleness check report and the user selects which STALE or MISSING docs to regenerate. UNVERIFIABLE docs are reported but never offered. The Refresh Gate is absent from batch refresh and skipped when `auto` is passed. _Avoid_: Confirmation prompt, review step, interactive mode +**Docs Index**: +The README section (`## Documentation`) listing every user-facing doc in `docs/` with a one-line description. The readme task is its sole writer; the check task flags README STALE when a doc is unlinked or an index link is dead. Internal `.forerunner/` artifacts are never indexed. +_Avoid_: Table of contents, docs section, doc links + **Agent Onboarding**: A task that creates or refreshes the instructions and domain vocabulary a coding agent needs before working in a repo. Agent Onboarding may create or update `CONTEXT.md` with conservative glossary terms inferred from stable repo evidence. _Avoid_: Init docs, setup docs @@ -58,6 +62,10 @@ Dev: "Add a new prompt task." Domain expert: "Register it in the Task Registry so wrappers, skills, docs, and refresh policy read the same task identity." +Dev: "The README doesn't link the docs refresh just generated." + +Domain expert: "That is a stale Docs Index: check should mark README STALE, and the readme task — running last in refresh — rebuilds the index from what exists in `docs/`." + Dev: "Make refresh ask before it rewrites docs." Domain expert: "That is the Refresh Gate: after the staleness check, offer the STALE and MISSING docs for selection; batch refresh and `auto` runs bypass it."