mirror of
https://github.com/agent0ai/dox.git
synced 2026-08-16 01:16:40 +02:00
frdel
f34ec7ad10
Include a new video-thumbnail.jpg and embed a linked thumbnail in README.md pointing to the demo video. Update AGENTS.md child DOX index to state no child AGENTS.md files are needed and list root-owned files (README.md, LICENSE, banner.jpg, video-thumbnail.jpg, and root-level docs). These changes add the video asset and clarify the repository's documentation indexing.
45 lines
1.9 KiB
Markdown
45 lines
1.9 KiB
Markdown
<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?"
|
|
|
|
<p align="center">
|
|
<a href="https://youtu.be/NVkRkioBXQc">
|
|
<img src="./video-thumbnail.jpg" alt="Watch: One markdown file just fixed AI coding forever." width="640">
|
|
</a>
|
|
</p>
|
|
|
|
## 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>
|