Skip to content

[docs] Docs #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Edgardo-Ramirez-Canales wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] Docs #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,19 @@ For an existing project, you can tell your agent: `Initialize DOX tree for this
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>

## Usage Examples

To better understand how to implement DOX in your projects, here are a few examples:

### Example 1: Basic Setup
1. Create a new project directory.
2. Copy the contents of [AGENTS.md](./AGENTS.md?plain=1) into your project's AGENTS.md file.
3. Initialize the DOX tree by running `Initialize DOX tree for this project now.`

### Example 2: Updating AGENTS.md
1. After making changes to your project, review the relevant AGENTS.md files.
2. Update the nearest owning AGENTS.md to reflect any changes in responsibilities or scope.
3. Ensure to refresh the Child DOX Index to keep documentation current.

These examples illustrate the straightforward process of using DOX to maintain project documentation effectively.