L'électron rareandClaude Opus 4.6
472cfe4ba6
Plan 03: test_integration_hil.sh, power_profiling.sh Plan 07: .github/pull_request_template.md (spec link + AC checklist) Plan 08: check_emc_radio_lvd.py, setup_branch_protection.sh Plan 10: issue_to_pr_walkthrough.md, check_doc_links.sh, check_doc_commands.sh Plan 11: CODEOWNERS, compliance_gate_tests.py All 10 items closed across 5 plans. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
1.5 KiB
1.5 KiB
10) Plan de documentation & onboarding
Objectif
Maintenir une documentation simple, à jour, orientée exécution (pas marketing) avec exemples.
Labels recommandés
type:docs+ai:docs
Étapes
1. Pages indispensables
README.md(pitch + quickstart) — Delivered:README.mdexistsdocs/INSTALL.md— Delivered:docs/INSTALL.mdexistsdocs/RUNBOOK.md— Delivered:docs/RUNBOOK.mdexistsdocs/FAQ.md— Delivered:docs/FAQ.mdexists
2. Exemples
- “Minimal project” (spec + firmware stub + test native) — Delivered:
specs/00_intake.mdthroughspecs/04_tasks.md+firmware/src/main.cpp+firmware/test/test_basic.cpp - “Issue → PR” walkthrough — Delivered:
docs/guides/issue_to_pr_walkthrough.md
3. Docs auto-générées
- Référencer ce qui est généré et ce qui est manuel — Delivered:
docs/index.md+.github/workflows/jekyll-gh-pages.yml - Garder la nav cohérente — Delivered:
docs/index.md
4. Qualité docs
- Liens internes OK — Delivered:
tools/check_doc_links.sh(scans docs/ for broken relative links) - Commandes testées — Delivered:
tools/check_doc_commands.sh(extracts bash blocks from docs and smoke-tests them) - Aucune info sensible — Delivered:
.github/workflows/secret_scan.yml
Gates
- Lint markdown (si activé)
- Review humaine
Critère de sortie
✅ Un nouveau peut exécuter le workflow en 15 minutes sans aide.
Références
docs/index.mddocs/workflows/README.md