dox  by agent0ai

AI agent framework for dynamic project documentation

Created 2 weeks ago

New!

922 stars

Top 38.9% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

DOX addresses AI agents' imprecise code modifications due to a lack of specific project context. This framework enables agents to maintain precise project understanding and local coding guidelines via a hierarchical AGENTS.md system. By ensuring agents consult relevant documentation before and after edits, DOX minimizes guesswork, reduces code drift, and improves AI-driven development reliability. It targets users of AI coding assistants seeking more controlled, context-aware automated code changes.

How It Works

DOX establishes a hierarchical structure of AGENTS.md files within a project. The root AGENTS.md contains project-wide instructions and an index; child AGENTS.md files provide granular, local guidelines. Before editing, an AI agent traverses this documentation tree from the root to identify precise local rules. Post-modification, the agent updates affected AGENTS.md files, maintaining documentation currency. This systematic approach ensures agents act with exact, context-specific instructions, preventing arbitrary edits.

Quick Start & Requirements

  • Installation: No installation required. Copy DOX AGENTS.md content into your project's root AGENTS.md.
  • Prerequisites: Requires an AI agent capable of interpreting AGENTS.md files (e.g., Codex, Claude Code, OpenCode).
  • Setup: Zero setup time or resource footprint beyond integrating AGENTS.md.
  • Links: Website and GitHub repository mentioned, but direct URLs are not provided.

Highlighted Details

  • Self-Documenting Framework: Utilizes AGENTS.md hierarchy for precise, context-aware AI agent instructions.
  • Minimalist Design: Pure Markdown instruction set; no installation, dependencies, packages, or runtime.
  • Contextual Editing: Agents traverse AGENTS.md tree for exact local guidelines before edits, reducing blind modifications.
  • Automated Documentation Updates: Agents update affected AGENTS.md files post-edit, keeping documentation current with code changes.

Maintenance & Community

Created by Agent Zero. Website and GitHub repository links are indicated but not provided.

Licensing & Compatibility

The license type is not specified. Compatibility is stated for any AI agent supporting AGENTS.md files. No specific notes on commercial use or closed-source linking are present.

Limitations & Caveats

DOX's effectiveness hinges on the AI agent's ability to correctly interpret and implement the AGENTS.md hierarchy and traversal logic. It is a specification for agents, requiring agent-side support for its functionality.

Health Check
Last Commit

2 weeks ago

Responsiveness

Inactive

Pull Requests (30d)
1
Issues (30d)
2
Star History
925 stars in the last 19 days

Explore Similar Projects

Starred by Peter Norvig Peter Norvig(Author of "Artificial Intelligence: A Modern Approach"; Research Director at Google).

codev by cluesmith

1.4%
278
AI-powered OS for human-agent software co-development
Created 9 months ago
Updated 16 hours ago
Feedback? Help us improve.