Skip to content

FSHSP-116 docs: document the two consumption modes and refocus the root README - #42

Merged
LBU4SH merged 3 commits into
mainfrom
worktree-docs+readme-consumption-modes
Aug 18, 2026
Merged

FSHSP-116 docs: document the two consumption modes and refocus the root README#42
LBU4SH merged 3 commits into
mainfrom
worktree-docs+readme-consumption-modes

Conversation

@LBU4SH

@LBU4SH LBU4SH commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

FSHSP-116

FSHSP-109 a livré le mode starter (ng add, sources copiées chez le consommateur) sans qu'il apparaisse nulle part sur la page npmjs — seule documentation d'un consommateur du kit. Cette PR le documente, et corrige au passage l'orientation du README racine, qui ne disait pas comment consommer le kit du tout.

README du package (= page npmjs)

Nouvelle section « Deux modes de consommation », placée avant Installation puisqu'elle conditionne toute la suite : tableau comparatif dépendance / starter (ce qui arrive dans le dépôt, imports, styles, personnalisation, mise à jour), une phrase de recommandation, puis les commandes ng add / add / add --all / update. Une ligne indique explicitement que la suite de la page décrit le mode dépendance.

README.md et README.fr.md étant des miroirs : les deux.

Détails vérifiés dans le code des schematics plutôt que devinés :

  • les sources sont copiées dans src/app/shared/components/ui/<catégorie>/<composant> (utils/component-registry.ts) ;
  • en mode starter, @4sh/ui-kit reste une devDependency — seules ses peerDependencies deviennent des dependencies directes (ng-add/index.ts).

README racine : 240 → 106 lignes

Il était entièrement orienté contributeur. Deux problèmes :

  1. Aucune ligne ne disait comment consommer le kit.
  2. L'arborescence documentée (projects/ui-kit/, ng-package.json, public-api.ts) n'existe que dans ce dépôt : ni npm install ni ng add ne la produisent. Pour un lecteur, elle décrivait un dépôt qu'il n'a pas.

Nouvelle structure : pitch → liens (Storybook / démo / npmjs) → Stack → Using the kit in an application (les deux modes, renvoi au README du package) → Working in this repo (les commandes, renvoi à AGENTS.md) → Going further.

Supprimé : Structure, CSS class conventions, Adding a new component, Storybook — file organization, CSS variable naming, Themes & modes. Tout est déjà dans AGENTS.md (## Architecture, ### CSS / SCSS, ### Theme, brand, modes, ## Workflows, la règle ng-packagr sur les imports, le nommage des variables), qui reste la source unique des conventions — pour les humains comme pour les agents. C'est exactement cette duplication qui avait laissé le nombre d'entry points annoncé devenir faux à deux endroits sur trois.

Seule exception, déplacée plutôt que supprimée : « la sidebar Storybook est pilotée par le title, pas par l'emplacement du fichier » → AGENTS.md.

Storybook « Package npm »

Même ajout, à sa profondeur : la commande ng add et le renvoi, sans recopier le tableau. La page délègue volontairement au README du package.

Portée

Documentation seule, aucun changement de code. Le README part avec le tarball : visible sur npmjs à la prochaine publication, d'où l'entrée CHANGELOG sous [Unreleased] › Added. Le README racine, AGENTS.md et la page Storybook ne sont pas dans le tarball.

🤖 Generated with Claude Code

LBU4SH added 3 commits August 17, 2026 11:52
Le README du kit — donc la page npmjs, seule documentation d'un consommateur —
ne mentionnait ni `ng add`, ni les schematics, ni le mode starter livré par
FSHSP-109. Nouvelle section « Deux modes de consommation » avant l'installation :
tableau comparatif dépendance / starter (ce qui arrive dans le dépôt, imports,
styles, personnalisation, mise à jour), puis les commandes add / update. EN + FR,
les deux fichiers étant des miroirs.

La page Storybook « Package npm » gagne le même renvoi, à sa profondeur : la
commande et le pointeur, sans recopier le tableau.
Le README racine était entièrement orienté contributeur : sur 240 lignes, aucune
ne disait comment consommer le kit, et l'arborescence documentée (projects/ui-kit,
ng-package.json, public-api.ts) n'existe que dans ce dépôt — ni `npm install` ni
`ng add` ne la produisent. 106 lignes désormais : pitch, liens, stack, « Using the
kit in an application » (les deux modes + renvoi au README du package), « Working
in this repo » (les commandes + renvoi à AGENTS.md).

Supprimé : Structure, CSS class conventions, Adding a new component, Storybook file
organization, CSS variable naming, Themes & modes — tous déjà dans AGENTS.md, source
unique pour les conventions. C'est cette duplication qui avait laissé le nombre
d'entry points devenir faux à deux endroits sur trois.

Seule exception déplacée plutôt que supprimée : la sidebar Storybook est pilotée par
le `title`, pas par l'emplacement du fichier — AGENTS.md ne le disait pas.
Conflit de fond, pas seulement textuel : cette branche documentait les deux
modes avec les commandes d'avant FSHSP-122 (`ng add @4sh/ui-kit`,
`ng generate @4sh/ui-kit:add`), que `main` a remplacées par le parcours du
package compagnon. La fusion automatique aurait laissé la page se contredire
— un tableau renvoyant à des commandes qui n'existent plus, suivi de la
section qui donne les bonnes.

Résolution : on garde l'apport de FSHSP-116, le tableau comparatif qui aide à
choisir avant d'installer, aux commandes d'aujourd'hui et avec une ligne de
plus (la documentation, que `--with-storybook` rend locale). Sa section
« Mode starter » disparaît : `main` la couvre déjà, correctement, et deux
descriptions du même parcours divergeraient à la première évolution.

Alignés au passage sur le parcours actuel : le README racine et la page
Storybook `NpmPackage.mdx`, qui portaient les mêmes commandes obsolètes. La
note ajoutée à AGENTS.md précise que story et MDX ne partent pas dans
`@4sh/ui-kit` mais voyagent bien dans le compagnon depuis FSHSP-125.
@LBU4SH
LBU4SH merged commit 8a97fca into main Aug 18, 2026
2 of 3 checks passed
@LBU4SH
LBU4SH deleted the worktree-docs+readme-consumption-modes branch August 18, 2026 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant