[Docs] Rédiger les README.md manquants pour chaque crate #315

New issue

Open

opened 2026-04-06 09:35:07 +00:00 by charles · 0 comments

charles commented

2026-04-06 09:35:07 +00:00

Owner

Contexte

La spec section 9.2 stipule : "Chaque crate a un README.md". Actuellement, seule crates/fractal-ext/ a un README. Les 6 autres crates n'en ont pas.

Un README par crate est nécessaire pour que le dev bot (et les contributeurs) comprennent le périmètre de chaque crate sans lire tout le code.

Critères d'acceptation

crates/fractal-stt/README.md — objectif, trait SttEngine, moteurs supportés, config
crates/fractal-ai/README.md — objectif, AgentDetector, streaming, canvas, multi-agent
crates/fractal-rich/README.md — objectif, RichBlock, parser HTML→blocs, liste des widgets fx-*
crates/fractal-bridge/README.md — objectif, BridgeType, UnifiedContact, UnifiedTimeline
crates/fractal-core/README.md — objectif, gestion de config, AppConfig
crates/fractal-gtk/README.md — objectif, widgets GTK ajoutés, dépendances (webkit2gtk, etc.)
Chaque README suit le même plan : Rôle, Structure, Utilisation, Dépendances

Notes techniques

Les README n'ont pas besoin d'être exhaustifs, mais doivent suffire pour comprendre le rôle du crate et ses points d'entrée publics
S'inspirer de crates/fractal-ext/README.md comme modèle

## Contexte La spec section 9.2 stipule : "Chaque crate a un README.md". Actuellement, seule `crates/fractal-ext/` a un README. Les 6 autres crates n'en ont pas. Un README par crate est nécessaire pour que le dev bot (et les contributeurs) comprennent le périmètre de chaque crate sans lire tout le code. ## Critères d'acceptation - [ ] `crates/fractal-stt/README.md` — objectif, trait `SttEngine`, moteurs supportés, config - [ ] `crates/fractal-ai/README.md` — objectif, `AgentDetector`, streaming, canvas, multi-agent - [ ] `crates/fractal-rich/README.md` — objectif, `RichBlock`, parser HTML→blocs, liste des widgets fx-* - [ ] `crates/fractal-bridge/README.md` — objectif, `BridgeType`, `UnifiedContact`, `UnifiedTimeline` - [ ] `crates/fractal-core/README.md` — objectif, gestion de config, `AppConfig` - [ ] `crates/fractal-gtk/README.md` — objectif, widgets GTK ajoutés, dépendances (webkit2gtk, etc.) - [ ] Chaque README suit le même plan : **Rôle**, **Structure**, **Utilisation**, **Dépendances** ## Notes techniques - Les README n'ont pas besoin d'être exhaustifs, mais doivent suffire pour comprendre le rôle du crate et ses points d'entrée publics - S'inspirer de `crates/fractal-ext/README.md` comme modèle

charles added the

priority:low

type:chore

module:M0-setup

labels

2026-04-06 09:35:07 +00:00

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

charles/my-fractal#315

No description provided.

Rows
Columns