What problem does it solve?
It helps developers quickly understand how a Forge-based project is organized and which parts are generated versus hand-written, so teams can make safe changes without accidentally editing code that will be overwritten.
Core Features & Use Cases
- Project structure orientation: Maps the major directories (cmd/, internal/, gen/, handlers/, frontends/, db/) to their roles in the system.
- Generated vs hand-written clarity: Explains concrete signals (_gen naming, provenance headers, scaffold markers) that determine what Forge will regenerate.
- Generate pipeline transparency: Documents how proto and contract changes flow through descriptor/ORM/TS generation steps.
- Custom wiring guidance: Directs developers to use pkg/app/setup.go for wiring while keeping pkg/app/bootstrap.go untouched.
- Workflow for drift detection: Recommends forge audit/map/generate --explain to understand what changed and why.
Quick Start
Ask: “Explain which parts of this Forge project are safe to edit and how to identify forge-generated code using the rules for _gen files and scaffold markers.”