Start with the path that matches what you are trying to do. Installing and using agents-feedback does not require reading the maintainer specification or release process.
| Topic | Authoritative document |
|---|---|
| Product overview and navigation | Repository README |
| Human installation, first use, and troubleshooting | Getting started |
| Fresh installation procedure for agents | Installer |
| Upgrade procedure for agents | Upgrade guide |
| Installed operational behavior | Operational agent instructions |
| Scaffold contract | Specification |
| Contribution requirements | Contributing |
| Release body and draft workflow | Release notes guide |
Other documents should summarize and link to these authorities instead of copying their detailed rules.
- Repository overview explains the product and the three-step installation path.
- Getting started covers installation, verification, first use, upgrades, and troubleshooting.
- Latest GitHub release provides the installation ZIP.
- Scaffold specification defines layout, records, lifecycle, safety, state output, installation, and upgrades.
- Installed folder guide explains the files users receive in the ZIP.
- Operational agent instructions define how agents consume and maintain feedback after installation.
- Support routes questions, bugs, feature requests, and sensitive reports.
- Security policy defines the private reporting path.
- GitHub Discussions is the place for usage and design questions.
- GitHub Issues is the place for reproducible bugs and concrete feature requests.
- Contributing defines development checks and contribution boundaries.
- Changelog summarizes public product releases.
- Release notes define release body sources and the approval-gated draft workflow.
docs/plans/preserves design and execution history; implementation plans are not installation or usage documentation.