Glossary

June 14, 2026 ยท View on GitHub

TermMeaning
CheckFriendly one-screen readiness result with exact next command
DoctorRead-only scan that recommends init, adopt, or repair
InitCreate a fresh docflow docs tree for repos without meaningful docs
AdoptAdd docflow infrastructure around existing docs without overwriting them
RepairRegenerate generated docs map, reinstall helpers, and report links/placeholders
ValidateRead-only readiness gate that blocks broken docs via non-zero exit
Docs rootDirectory configured by docflow.json as the project documentation root
Metadata commentLightweight <!-- docflow: ... --> marker describing a doc's role
Update logPer-document table recording date, change, and source/reference
Changelog memoryMonthly append-only shipped-work record surfaced to agents
Agent guidanceRoot files such as AGENTS.md, GEMINI.md, and .cursorrules
Docs mapGenerated INDEX.md with one path โ€” purpose line per Markdown file