v0.1.0-pre.074
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/README.md -->
|
||||
<!-- version: 6 -->
|
||||
<!-- version: 7 -->
|
||||
|
||||
# Documentation active de Khadhroony Bot3
|
||||
|
||||
@@ -36,14 +36,13 @@ Modèles documentaires non génératifs :
|
||||
- [`templates/CRATE_USAGE_TEMPLATE.md`](templates/CRATE_USAGE_TEMPLATE.md) ;
|
||||
- [`templates/CRATE_CHANGELOG_TEMPLATE.md`](templates/CRATE_CHANGELOG_TEMPLATE.md).
|
||||
|
||||
## 4. Audits et décisions en cours
|
||||
## 4. Audits et décisions actifs
|
||||
|
||||
- [`DOCUMENTATION_REFACTOR_AUDIT.md`](DOCUMENTATION_REFACTOR_AUDIT.md) ;
|
||||
- [`DOCUMENTATION_REFACTOR_PLAN.md`](DOCUMENTATION_REFACTOR_PLAN.md) ;
|
||||
- [`audits/V0_4_6_ALIGNMENT_AUDIT.md`](audits/V0_4_6_ALIGNMENT_AUDIT.md) ;
|
||||
- [`decisions/DOCUMENT_ARCHIVE_SELECTION_POLICY.md`](decisions/DOCUMENT_ARCHIVE_SELECTION_POLICY.md) ;
|
||||
- [`decisions/WINCODE_COMPATIBILITY_POLICY.md`](decisions/WINCODE_COMPATIBILITY_POLICY.md).
|
||||
|
||||
Ces audits seront archivés sous `olddocs/archivekbot3/` lorsqu’ils auront été remplacés par des documents normatifs ou des rapports de clôture.
|
||||
Les audits et prompts de migration remplacés sont conservés sous `olddocs/archivekbot3/`.
|
||||
|
||||
## 5. Documents techniques actifs à reclasser
|
||||
|
||||
@@ -71,29 +70,19 @@ Elles peuvent être chargées directement par les tests unitaires ou d’intégr
|
||||
|
||||
## 7. Documentation par crate
|
||||
|
||||
Chaque crate devra posséder :
|
||||
Les onze crates possèdent désormais `README.md`, `TODO.md`, `USAGE.md` et `CHANGELOG.md` :
|
||||
|
||||
```text
|
||||
README.md
|
||||
TODO.md
|
||||
USAGE.md
|
||||
CHANGELOG.md
|
||||
```
|
||||
|
||||
Leur création commencera après stabilisation des documents transversaux, par lots de crates. `USAGE.md` documentera les APIs publiques réelles et pourra signaler les tests particulièrement instructifs.
|
||||
|
||||
## Documentation des crates
|
||||
|
||||
Le premier lot documenté comprend :
|
||||
|
||||
- [`kb-lib`](../kb-lib/README.md) ;
|
||||
- [`kb-store`](../kb-store/README.md) ;
|
||||
- [`kb-core`](../kb-core/README.md) ;
|
||||
- [`kb-config`](../kb-config/README.md) ;
|
||||
- [`kb-logging`](../kb-logging/README.md).
|
||||
|
||||
## Audits
|
||||
|
||||
- [Audit d’alignement des TODO par crate](audits/CRATE_TODO_VERSION_ALIGNMENT_AUDIT.md)
|
||||
- [`kb-lib`](../kb-lib/README.md) ;
|
||||
- [`kb-logging`](../kb-logging/README.md) ;
|
||||
- [`kb-program-ids`](../kb-program-ids/README.md) ;
|
||||
- [`kb-pipeline`](../kb-pipeline/README.md) ;
|
||||
- [`kb-pipeline-demo-scenarios`](../kb-pipeline-demo-scenarios/README.md) ;
|
||||
- [`kb-onchain-transport`](../kb-onchain-transport/README.md) ;
|
||||
- [`kb-store`](../kb-store/README.md) ;
|
||||
- [`kb-wallet`](../kb-wallet/README.md) ;
|
||||
- [`kb-app-demo-desktop`](../kb-app-demo-desktop/README.md).
|
||||
|
||||
## Guides
|
||||
|
||||
|
||||
Reference in New Issue
Block a user