Documentation¶
The maintained public documentation has distinct roles:
| Document | Role |
|---|---|
| Repository README | concise repository overview and benchmark results |
| Quick start guide | recipe launcher quick start |
../index.md |
public documentation home |
../concepts/design.md |
framework model and ownership boundaries |
| Source architecture map | enforced src/evolve/ module map and budgets |
../reference/terminology.md |
canonical framework language |
coding-style.md |
coding conventions |
../rsihub-mark.svg |
generated RSIHub Ring identity mark |
../rsihub-wordmark.svg |
generated RSIHub gradient wordmark |
../evolve-lineage.svg |
generated README identity figure |
../assets/architecture.svg |
generated architecture diagram |
| Operator interfaces | machine-readable operator contract |
Put dated proposals in docs/designs/ and implementation plans in
docs/plans/. Update the maintained document that describes a behavior in the
same change as that behavior.
Regenerate the maintained README visuals after changing their content or style: