Central index for where documentation lives and how to keep it consistent across the main repository and this GitHub Wiki.
| Kind | Location | Notes |
|---|---|---|
| Contributor workflows | AGENTS.md |
Ownership rules, crate map pointers |
| Architecture contracts | docs/architecture/ARCHITECTURE.md |
System design + invariants |
| CLI behavior | docs/CLI.md |
Flags, outputs—must match releases |
| Evaluation harness | docs/EVALUATION.md |
External reproducibility |
| Release notes | docs/changelog/ |
Immutable release history |
| CI/CD semantics | .github/workflows/, .github/CI_CD_GUIDE.md |
Automation truth |
Rendered wiki: https://github.com/sjkim1127/Fission/wiki
Wiki Git repository: https://github.com/sjkim1127/Fission.wiki.git
Use the wiki for high-churn operational guidance:
Keep behavior-changing contracts in the tracked repository (docs/, .github/, AGENTS.md) so they ride alongside code review.
| Category | Canonical location | Rule of thumb |
|---|---|---|
| Behavior / APIs / CI semantics | Repository (docs/, workflows, crate docs) |
Requires PR review with code |
| Tutorials / runbooks / FAQs | Wiki | Fast iteration; link back to repo paths |
| Raw automation artifacts | Repository paths (benchmark/artifacts/ conventions) |
Large binaries stay ignored unless curated fixtures |
Wiki pages must link to concrete paths on main when referencing behavior. If wiki prose disagrees with docs/ or code, treat the wiki as stale until corrected.
docs/ or AGENTS.md whenever semantics or CLI contracts shift—those updates merge with feature PRs.docs/changelog/, not wiki-only announcements.NirBuildStats, automation summaries)—avoid parallel undocumented payloads (see AGENTS.md).