mirror of
https://github.com/agno-agi/agno.git
synced 2026-10-12 02:10:54 +00:00
Update projects to specs
This commit is contained in:
@@ -77,6 +77,7 @@ agno_json_data/
|
||||
.cursor/
|
||||
|
||||
# Private design documents (symlinked)
|
||||
specs
|
||||
projects
|
||||
|
||||
# ignore pyrightconfig.json
|
||||
|
||||
@@ -11,7 +11,7 @@ agno/
|
||||
├── libs/agno/agno/ # Core framework code
|
||||
├── cookbook/ # Examples, patterns and test cases (organized by topic)
|
||||
├── scripts/ # Development and build scripts
|
||||
├── projects/ # Design documents (symlinked, private)
|
||||
├── specs/ # Design documents (symlinked, private)
|
||||
└── .cursorrules # Coding patterns and conventions
|
||||
```
|
||||
|
||||
@@ -92,15 +92,15 @@ Format:
|
||||
|
||||
## Design Documents
|
||||
|
||||
The `projects/` folder contains design documents for ongoing initiatives. If you're working on one of the following projects:
|
||||
- `projects/learning-machine/` — Unified learning system for agents
|
||||
The `specs/` folder contains design documents for ongoing initiatives. If you're working on one of the following:
|
||||
- `specs/learning-machine/` — Unified learning system for agents
|
||||
|
||||
**Always read the design document first**.
|
||||
|
||||
Each project follows this structure:
|
||||
Each spec follows this structure:
|
||||
```
|
||||
projects/<project-name>/
|
||||
├── CLAUDE.md # Project-specific instructions (read this first)
|
||||
specs/<spec-name>/
|
||||
├── CLAUDE.md # Spec-specific instructions (read this first)
|
||||
├── design.md # The specification
|
||||
├── implementation.md # Current status and what's done
|
||||
├── decisions.md # Why decisions were made
|
||||
@@ -108,7 +108,7 @@ projects/<project-name>/
|
||||
```
|
||||
|
||||
**Workflow:**
|
||||
1. Read the project's `CLAUDE.md` for specific instructions
|
||||
1. Read the spec's `CLAUDE.md` for specific instructions
|
||||
2. Read `design.md` to understand what we're building
|
||||
3. Check `implementation.md` for current status
|
||||
4. Find the relevant code in `libs/agno`
|
||||
@@ -163,7 +163,7 @@ pytest libs/agno/tests/unit/test_agent.py
|
||||
|
||||
## When Implementing Features
|
||||
|
||||
1. **Check for design doc** in `projects/` — if it exists, follow it
|
||||
1. **Check for design doc** in `specs/` — if it exists, follow it
|
||||
2. **Look at existing patterns** — find similar code and follow conventions
|
||||
3. **Create a cookbook** — every pattern should have an example
|
||||
4. **Update implementation.md** — mark what's done
|
||||
|
||||
@@ -138,7 +138,7 @@ learning_machine.learned_knowledge_store.print(query="...")
|
||||
|
||||
## Known Issues
|
||||
|
||||
1. **Design docs missing**: The `projects/learning-machine/` directory referenced in the main CLAUDE.md doesn't exist.
|
||||
1. **Design docs missing**: The `specs/learning-machine/` directory referenced in the main CLAUDE.md doesn't exist.
|
||||
|
||||
2. **HITL mode**: Not implemented in any store - warnings are logged but no actual human-in-the-loop functionality.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user