114 lines
5.5 KiB
Markdown
114 lines
5.5 KiB
Markdown
<!-- file: docs/README.md -->
|
||
<!-- version: 32 -->
|
||
|
||
# Documentation active de Khadhroony Bot3
|
||
|
||
## 1. Statut
|
||
|
||
Ce répertoire contient la documentation active, normative ou opérationnelle de `khadhroony-bot3`.
|
||
|
||
La documentation historique est conservée sous `olddocs/`. Les documents archivés ne doivent pas être considérés seuls comme normatifs ; les règles, guides, matrices et rapports finaux actifs décrivent l’état courant.
|
||
|
||
## 2. Architecture
|
||
|
||
- [`architecture/PROJECT_OBJECTIVES.md`](architecture/PROJECT_OBJECTIVES.md) : objectifs et limites du projet ;
|
||
- [`architecture/ARCHITECTURE.md`](architecture/ARCHITECTURE.md) : couches et flux principaux ;
|
||
- [`architecture/CRATE_MAP.md`](architecture/CRATE_MAP.md) : responsabilités des 11 crates ;
|
||
- [`architecture/PIPELINE_ARCHITECTURE.md`](architecture/PIPELINE_ARCHITECTURE.md) : orchestration, replay et exécution ;
|
||
- [`architecture/STORAGE_ARCHITECTURE.md`](architecture/STORAGE_ARCHITECTURE.md) : contrats de stockage et PostgreSQL ;
|
||
- [`architecture/SURFACE_CRATE_MATRIX.md`](architecture/SURFACE_CRATE_MATRIX.md) : répartition des responsabilités par surface.
|
||
|
||
## 3. Règles
|
||
|
||
Le point d’entrée normatif unique est [`../RULES.md`](../RULES.md).
|
||
|
||
Règles spécialisées :
|
||
|
||
- [`rules/RULES_GENERAL.md`](rules/RULES_GENERAL.md) ;
|
||
- [`rules/RULES_RUST.md`](rules/RULES_RUST.md) ;
|
||
- [`rules/RULES_SPECIFIC_KHADHROONY.md`](rules/RULES_SPECIFIC_KHADHROONY.md) ;
|
||
- [`rules/CRATE_DOCUMENTATION_RULES.md`](rules/CRATE_DOCUMENTATION_RULES.md) ;
|
||
- [`rules/VERSION_DEVELOPMENT_LIFECYCLE.md`](rules/VERSION_DEVELOPMENT_LIFECYCLE.md).
|
||
|
||
Modèles documentaires non génératifs :
|
||
|
||
- [`templates/CRATE_README_TEMPLATE.md`](templates/CRATE_README_TEMPLATE.md) ;
|
||
- [`templates/CRATE_TODO_TEMPLATE.md`](templates/CRATE_TODO_TEMPLATE.md) ;
|
||
- [`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 actifs
|
||
|
||
- [`decisions/DOCUMENT_ARCHIVE_SELECTION_POLICY.md`](decisions/DOCUMENT_ARCHIVE_SELECTION_POLICY.md) ;
|
||
- [`decisions/WINCODE_COMPATIBILITY_POLICY.md`](decisions/WINCODE_COMPATIBILITY_POLICY.md) ;
|
||
- [`decisions/KHADHROONY_SOLANA_NAMESPACE_POLICY.md`](decisions/KHADHROONY_SOLANA_NAMESPACE_POLICY.md) : séparation Khadhroony Solana/Bot, migration `ks-*` / `KS_*`, identités techniques et namespaces SQL.
|
||
|
||
Les audits et rapports de travail `0.4.8-pre.*` sont archivés sous `../olddocs/archivekbot3/`. Leur contenu reste disponible pour la traçabilité mais n’est plus un index actif.
|
||
|
||
## 5. Documents techniques actifs
|
||
|
||
- [`DEVNET_EXECUTION_GUIDE.md`](DEVNET_EXECUTION_GUIDE.md) ;
|
||
- [`IDL_AUDIT.md`](IDL_AUDIT.md) ;
|
||
- [`IDL_TO_KB_LIB_NOMENCLATURE.md`](IDL_TO_KB_LIB_NOMENCLATURE.md) ;
|
||
- [`MISSING_PROGRAM_IDLS.md`](MISSING_PROGRAM_IDLS.md) ;
|
||
- [`OPERATION_NAMING_CONVENTION.md`](OPERATION_NAMING_CONVENTION.md) ;
|
||
- [`IDEA_REMINDERS.md`](IDEA_REMINDERS.md).
|
||
|
||
Les idées ne rejoignent un `TODO.md` qu’après confirmation, attribution et reformulation en tâche vérifiable.
|
||
|
||
## 6. Matrices contractuelles
|
||
|
||
Les matrices canoniques sont conservées sous :
|
||
|
||
```text
|
||
test-fixtures/contract-matrices/
|
||
```
|
||
|
||
Elles peuvent être chargées directement par les tests unitaires ou d’intégration. Elles ne doivent pas être dupliquées sous `docs/`.
|
||
|
||
## 7. Documentation par crate
|
||
|
||
Les onze crates possèdent `README.md`, `TODO.md`, `USAGE.md` et `CHANGELOG.md` :
|
||
|
||
- [`ks-core`](../ks-core/README.md) ;
|
||
- [`ks-config`](../ks-config/README.md) ;
|
||
- [`ks-lib`](../ks-lib/README.md) ;
|
||
- [`ks-logging`](../ks-logging/README.md) ;
|
||
- [`ks-program-ids`](../ks-program-ids/README.md) ;
|
||
- [`ks-pipeline`](../ks-pipeline/README.md) ;
|
||
- [`ks-pipeline-demo-scenarios`](../ks-pipeline-demo-scenarios/README.md) ;
|
||
- [`ks-onchain-transport`](../ks-onchain-transport/README.md) ;
|
||
- [`ks-store`](../ks-store/README.md) ;
|
||
- [`ks-wallet`](../ks-wallet/README.md) ;
|
||
- [`kb-app-demo-desktop`](../kb-app-demo-desktop/README.md).
|
||
|
||
## 8. Guides
|
||
|
||
- [Configuration](guides/CONFIGURATION.md) ;
|
||
- [Logging et tracing](guides/LOGGING.md) ;
|
||
- [RPC, backfill et WebSocket](guides/RPC_BACKFILL_AND_WEBSOCKET.md) ;
|
||
- [Extraction Core, replay et matérialisation](guides/REPLAY_CORE_EXTRACTION_AND_MATERIALIZATION.md) ;
|
||
- [PostgreSQL et stockage](guides/POSTGRES_STORAGE.md) ;
|
||
- [Validation Devnet](guides/DEVNET_VALIDATION.md).
|
||
|
||
## 9. Rapports de validation actifs
|
||
|
||
- [Validation Metaplex Token Metadata 0.4.7](validation/V0_4_7_METAPLEX_TOKEN_METADATA_VALIDATION_REPORT.md) ;
|
||
- [Validation Metadata on-chain et clôture 0.4.8](validation/V0_4_8_METADATA_VALIDATION_REPORT.md) ;
|
||
- [`validation/WEBSOCKET_MAINNET_RESEARCH_VALIDATION_REPORT.md`](validation/WEBSOCKET_MAINNET_RESEARCH_VALIDATION_REPORT.md) ;
|
||
- [`validation/MAINNET_RESEARCH_BACKFILL_VALIDATION_SCENARIO.md`](validation/MAINNET_RESEARCH_BACKFILL_VALIDATION_SCENARIO.md).
|
||
|
||
Les preuves détaillées de `0.4.8-pre.*` restent accessibles sous `../olddocs/archivekbot3/docs/validation/` et dans `validation/evidence/v0.4.8/`.
|
||
|
||
## 10. Plans de version actifs
|
||
|
||
Le cadrage `0.5.0` est clôturé. Son plan et les audits `pre.002`/`pre.003` sont archivés sous `../olddocs/archivekbot3/docs/plans/`.
|
||
|
||
Plan actif de `0.5.1` :
|
||
|
||
- [`V0_5_1_KHADHROONY_SOLANA_NAMESPACE_AND_CONFIG_PLAN.md`](plans/V0_5_1_KHADHROONY_SOLANA_NAMESPACE_AND_CONFIG_PLAN.md) — inventaire de migration `ks-*` / `ks_*` / `KS_*`, configuration sûre et découpage borné des prereleases.
|
||
|
||
## 11. Prompt de reprise
|
||
|
||
- [`Prompt actif 0.5.1`](../prompts/030_v0_5_1_khadhroony_solana_namespace_and_config.md).
|