|
Refactored `AGENTS.md` to be a concise cheat sheet by:
1. Moving detailed examples of "Forbidden Patterns" and "Bug
Discovery" to `Omni/Task/README.md`. 2. Moving "Coding Conventions"
(Always include tests, No TODOs, Fast typechecking) to `README.md`. 3.
Removing "About Omnirepo" and "Source Layout" sections from `AGENTS.md`
as they are duplicative of `README.md`. 4. Condensing `AGENTS.md`
to contain only Critical Rules, a short Session Checklist/Cheat
Sheet, and pointers to the detailed READMEs (`Omni/Task/README.md`,
`Omni/Bild/README.md`, `Omni/Ide/README.md`, `README.md`).
Verified that detailed documentation exists in the respective
namespaces and passed linting.
|
|
I have successfully refactored `AGENTS.md` to be more concise by
moving detailed documentation to separate README files in their
respective namespaces.
**Changes made:** 1. **Created `Omni/Task/README.md`**: Contains
the detailed "Task Manager for AI Agents" documentation. 2.
**Created `Omni/Bild/README.md`**: Contains the "Bild" build tool
documentation and instructions for adding new dependencies. 3.
**Created `Omni/Ide/README.md`**: Contains the "Development Tools"
(run.sh, lint, etc.) and "Git Workflow" documentation. 4. **Updated
`AGENTS.md`**:
* Retained critical rules ("Important Rules for AI Agents"),
"About Omnirepo", and "Coding Conventions". * Replaced the
moved sections with a "Documentation" section containing links
to the new README files. * Used relative paths for links to
ensure portability.
**Verification:** * Ran `bild --test Omni/Task.hs` and `bild --test
Omni/Bild.hs` to ensure no regressions were introduced in the touched
namespaces.
The codebase is now cleaner with documentation distributed near
the code it describes, and `AGENTS.md` is now a focused entry point
for agents.
|
