Magent Documentation
Welcome to the Magent documentation. Stable user-facing material remains in the root README, while this directory holds developer guides, architecture notes, and troubleshooting docs.
Documentation Index
Getting Started
- ONBOARDING.md — New developer onboarding guide with architecture overview, guided tour, and complexity hotspots
- TROUBLESHOOTING.md — Common issues and solutions
Architecture
- AGENT_JOBS.md — Durable child-agent job lifecycle, tool surface, persistence, UI, and boundaries
Contribution
- CONTRIBUTING.md — Contribution guidelines, code style, testing, and PR process
Project Root Documentation
- ../README.org — Main project README with features, installation, and usage
- ../AGENTS.md — Development guide for agentic coding tools with build commands, architecture notes, and repository conventions
Quick Links
For New Contributors
- Start with ONBOARDING.md
- Read CONTRIBUTING.md for development workflow
- Read ../AGENTS.md for current architecture notes and development guidance
- Read AGENT_JOBS.md before changing child-agent lifecycle behavior
For Users
- ../README.org — Installation and configuration
- TROUBLESHOOTING.md — Common issues and solutions
- Run
M-x magent-doctor for self-diagnostics
- Use
C-c m ? for the transient menu
For Developers
- CONTRIBUTING.md — Code style and PR process
- ../AGENTS.md — Build commands, testing, architecture notes, and development guidance
- ONBOARDING.md — Architecture overview and guided code tour
- AGENT_JOBS.md — Current child-agent job architecture
Documentation Standards
When adding new documentation:
- Place user-facing docs in project root (README.org)
- Place developer docs in
docs/
- Prefer markdown for docs under
docs/ unless there is a clear reason to use org-mode
- Update this index when adding new files
- Keep stable docs or active task notes updated before stopping work so another machine can resume from git