Skip to content

v1.0.0

Choose a tag to compare

@jpbaking jpbaking released this 16 Jun 21:05
· 19 commits to main since this release

DOX is a lightweight AGENTS.md framework that gives AI agents precise project context through a hierarchy of local contracts. Copy one file into your project root and the agent builds and maintains the doc tree automatically.

What's in this release

This is the first versioned release of DOX, based on the original framework by Agent Zero, with modifications focused on cross-model reliability.

Changes from upstream

The original DOX framework is principle-based, which works well with capable models but leaves weaker models without a clear procedure to follow. This fork converts the principles into explicit steps:

  • Initialization procedure — added a numbered ## Initialization section with a concrete Done when check, so the bootstrap path is spelled out rather than inferred from maintenance rules.
  • Boundary heuristics — replaced the abstract "durable boundary" judgment with concrete criteria (own purpose / own audience / own build-run-test story), a bias toward fewer docs, and a shallow-first depth limit.
  • Example child doc — added a worked example to ## Child Doc Shape so models have a concrete referent alongside the section list.
  • Decoupled init trigger — separated the initialization instruction from the Child DOX Index placeholder, so models don't satisfy the init requirement by editing a single line.
  • Scenario-specific prompts — reworked the README How to use section with copy-paste prompts for three situations: new project, existing project with no docs yet, and a new agent session on a project that already has AGENTS.md files.
  • Jargon reduction — trimmed opaque terms (DOX rail, binding work contracts) on the procedural path without removing them from the conceptual sections where they carry meaning.

Usage

  1. Copy AGENTS.md into your project root.
  2. Use the prompt that matches your situation — see How to use in the README.