forkless/dox
1
0
Fork 0
mirror of https://github.com/agent0ai/dox.git synced 2026-08-16 09:26:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add DOX AGENTS.md, banner, and README updates

Browse Source 
Introduce AGENTS.md as the DOX root contract documenting the agent-driven docs workflow, rules for reading/updating hierarchical AGENTS.md files, and guidance for maintaining local and parent DOX docs. Update README.md to include a banner, an overview of how DOX works, quick usage instructions, and credits. Add banner.jpg used by the README.
This commit is contained in:
frdel
2026-06-01 13:34:24 +02:00
parent 2a420aeec0
commit 31e4561538
3 changed files with 121 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+38 -2
View File
@@ -1,2 +1,38 @@
# dox
Documentation framework using agents.md
<p align="center">
<img src="./banner.jpg" alt="DOX" width="100%">
</p>
## How DOX works
DOX is a tiny AGENTS.md framework that gives an AI agent precise project context.
The agent keeps a hierarchy of AGENTS.md files as the project changes:
- root AGENTS.md contains project-wide instructions and the top-level index
- child AGENTS.md files contain local instructions for specific areas
- before any edit, the agent walks the docs tree from the root to the area it will touch
- the relevant docs give it exact local guidelines, so it does not edit blindly
- after meaningful changes, it updates the affected AGENTS.md files
The result is simple: traverse the docs, understand the local rules, make precise edits, keep the docs current. Less guessing. Less drift. Less "why did it touch that file?"
## How to use
1. Copy the contents of [AGENTS.md](./AGENTS.md) into your project's AGENTS.md file.
<br>
That's it. No installation, no dependencies, no package, no runtime. DOX is just a Markdown instruction for AI agents.
It works with any AI agent that supports AGENTS.md files, including Codex, Claude Code, OpenCode, and similar tools.
No AGENTS.md yet? Copy the file into your project root. The agent will see these instructions and will start building the DOX tree.
For an existing project, you can tell your agent: `Initialize DOX tree for this project now.` It will create all the child AGENTS.md files and indexes.
## Credits
<p align="center">
Created by <strong><a href="https://www.agent-zero.ai/">Agent Zero</a></strong><br>
Open-source agentic AI framework<br>
<a href="https://www.agent-zero.ai/">Website</a> · <a href="https://github.com/agent0ai/agent-zero">GitHub repository</a>
</p>