bci-mvp / docs /DOCS_BUNDLE_INDEX.md
WilliamK112
feat: add final v1.0.0 release gate and integrate into release pipeline
1c8d8eb
|
Raw
History Blame Contribute Delete
1.97 kB
# Documentation Bundle Index
Generated: 2026-03-23 00:12 UTC
## Core
- βœ… [Technical report](TECHNICAL_REPORT.md) β€” `docs/TECHNICAL_REPORT.md`
- βœ… [Limitations report](LIMITATIONS.md) β€” `docs/LIMITATIONS.md`
- βœ… [Release readiness dashboard](RELEASE_READINESS.md) β€” `docs/RELEASE_READINESS.md`
- βœ… [HF Space readiness](HF_SPACE_READINESS.md) β€” `docs/HF_SPACE_READINESS.md`
- βœ… [Space user guide](SPACE_USER_GUIDE.md) β€” `docs/SPACE_USER_GUIDE.md`
- βœ… [Model card](MODEL_CARD.md) β€” `docs/MODEL_CARD.md`
- βœ… [Mathematical model](MATH_NOTATION.md) β€” `docs/MATH_NOTATION.md`
- βœ… [Methods (paper-style)](METHODS.md) β€” `docs/METHODS.md`
- βœ… [Results summary](RESULTS.md) β€” `docs/RESULTS.md`
- βœ… [Metrics registry](METRICS_REGISTRY.md) β€” `docs/METRICS_REGISTRY.md`
- βœ… [Data provenance](DATA_PROVENANCE.md) β€” `docs/DATA_PROVENANCE.md`
- βœ… [Results brief (EN)](RESULTS_BRIEF_EN.md) β€” `docs/RESULTS_BRIEF_EN.md`
- βœ… [Results brief (ZH)](RESULTS_BRIEF_ZH.md) β€” `docs/RESULTS_BRIEF_ZH.md`
- βœ… [Model leaderboard](MODEL_LEADERBOARD.md) β€” `docs/MODEL_LEADERBOARD.md`
- βœ… [Figure gallery](FIGURE_GALLERY.md) β€” `docs/FIGURE_GALLERY.md`
- βœ… [Auto changelog](CHANGELOG_AUTO.md) β€” `docs/CHANGELOG_AUTO.md`
- βœ… [Release pack EN](docs/release/release_en.md) β€” `docs/release/release_en.md`
- βœ… [Release pack ZH](docs/release/release_zh.md) β€” `docs/release/release_zh.md`
- βœ… [Reddit post draft](docs/release/reddit_post.md) β€” `docs/release/reddit_post.md`
- βœ… [Bilibili post draft](docs/release/bilibili_post.md) β€” `docs/release/bilibili_post.md`
- βœ… [Citation metadata](../CITATION.cff) β€” `CITATION.cff`
## One-command refresh sequence
```bash
python src/build_report.py
python src/release_readiness.py
python src/hf_space_readiness.py
python src/leaderboard.py
python src/generate_figure_gallery.py
python src/changelog_from_git.py
python src/generate_release_pack.py
python src/generate_model_card.py
```