FSHSP-107 docs: correct the import paths left stale by the category reorg - #32
Merged
Conversation
…eorg Follow-up to #31, which moved every ui-* component under a category folder and thereby renamed its npm sub-path — but left several docs describing the old flat layout, including the package README that ships in the tarball and renders on npmjs. - projects/ui-kit/README{,.fr}.md: every import example was still @4sh/ui-kit/ui-button — i.e. a path that no longer resolves, on the page a consumer reads first. The 'Available entry points' intro now states the <family>/<component> shape, and the family column is the literal path segment — so the Misc/Divers family is renamed Base, matching the base/ folder it had never mapped to. - AGENTS.md claimed the exact opposite of what #31 shipped ('No change to the npm entry points'): text written before the ng-packagr constraint surfaced and never revisited. It now states that the category IS part of the import path, with the reason and the consequence (moving a component across categories is breaking, not cosmetic). - AGENTS.md also carried three counts I had wrongly changed 54 -> 53: there are 53 entry points but 54 components, ui-file-upload-list having its own .scss (its own Sass compilation unit) inside ui-file-upload's entry point. - Remaining stale specifiers in the root README, storybook/docs/NpmPackage.mdx, and ui-icon.mdx, plus AGENTS.md's ConfigTable depth (../../../ -> ../../../../). CHANGELOG untouched on purpose: the [Unreleased] FSHSP-107 entry already states that every import changes, and nothing here has been released yet — a consumer never saw the wrong paths. Verified: all 6 documented import paths resolve to a real ng-package.json on disk, and components.check.mjs still validates the family tables against it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Correctif de suivi de #31. Ce PR-là a déplacé les 53 composants sous un dossier de catégorie — ce qui renomme leur chemin npm — mais plusieurs fichiers de doc décrivaient encore la structure à plat. Dont le pire : le README du package, livré dans le tarball et affiché sur npmjs.
Ce qui était faux
projects/ui-kit/README{,.fr}.mdimport { UiButton } from '@4sh/ui-kit/ui-button'AGENTS.mdng-packagrne se révèle, jamais reluAGENTS.mdAGENTS.mdConfigTableen../../../.mdxutilisent../../../../README.md,NpmPackage.mdx,ui-icon.mdxLa ligne
AGENTS.mdest la plus gênante en pratique : c'est le premier fichier que lit un agent IA sur ce repo, et il y trouvait l'affirmation opposée au code — de quoi écrire des imports faux en toute confiance.Au passage
La famille « Misc » / « Divers » est renommée « Base » dans les tables des deux README : maintenant que le texte annonce que la famille est le segment de chemin, « Misc » aurait désigné un dossier
misc/inexistant (c'estbase/).Vérifié
ng-package.jsonsur le disque (vérifié un par un, pas à l'œil).components.check.mjsvalide toujours les tables de familles contre le disque après le renommage.Pas touché volontairement
CHANGELOG.md: l'entrée[Unreleased]de FSHSP-107 dit déjà que chaque import change, et rien n'est encore publié — aucun consommateur n'a vu les mauvais chemins. Une entrée « on a corrigé la doc qui décrivait mal le changement du dessus » serait du bruit.@4sh/ui-kit/ui-icon: elles décrivent l'état de l'époque, l'historique ne se réécrit pas.