FEAT: Meerdere ReadME's kunnen inladen in documentatie pagina #1010
Comments
|
NL-Design system is ook bezig met documentatie structuur (in de Utrecht en Candidate repo), zelfs met versioning. Je kan meerder markdowns toevoegen met de mergeMarkdown functie: https://github.com/nl-design-system/utrecht/blob/fe34796f6e357316823f2da03c9971bc5e444d33/packages/storybook-helpers/src/markdown.tsx#L3 implementatie: https://github.com/nl-design-system/utrecht/blob/fe34796f6e357316823f2da03c9971bc5e444d33/packages/storybook-css/src/Image.stories.tsx#L11 Acceptatiecriteria is ook beschikbaar als markdown: https://github.com/nl-design-system/documentatie/tree/main/docs/componenten/ac |
|
Voor deze issue ga ik ook gelijk een parameter toevoegen waarmee je aan kan geven waar een component vandaan komt |
github-project-automation
bot
moved this from In Progress
to Done
in Community Sprint - Rijkshuisstijl
…ade small fixes to make everything as consistent as possible (#1070) closes #981 closes #1010 also made first steps to use @utrecht/components, but only in storybook for now (#1009) - There are a lot of // TODO comments because in a lot of cases the documentation is not structurized correctly in @utrecht/components. Wherever it was in the right structure I used the Utrecht documentation as much as possible (although sometimes they were very lacking in content, in which cases I skipped them as well) - I added functionality to packages/storybook/config/preview.tsx to render links and componentOrigin text that can be added using the github, figma, nldesignsystem and componentOrigin parameters in storybook respectively. - Here is an example of a storybook page where the links are filled with parameters and the documentation is coming from @utrecht/components: [Radio button](https://rijkshuisstijl-community-git-chore-utre-1cc52e-nl-design-system.vercel.app/?path=/docs/rhc-radio--docs) --------- Co-authored-by: Ruben Smit <[email protected]>
…ade small fixes to make everything as consistent as possible (#1070) closes #981 closes #1010 also made first steps to use @utrecht/components, but only in storybook for now (#1009) - There are a lot of // TODO comments because in a lot of cases the documentation is not structurized correctly in @utrecht/components. Wherever it was in the right structure I used the Utrecht documentation as much as possible (although sometimes they were very lacking in content, in which cases I skipped them as well) - I added functionality to packages/storybook/config/preview.tsx to render links and componentOrigin text that can be added using the github, figma, nldesignsystem and componentOrigin parameters in storybook respectively. - Here is an example of a storybook page where the links are filled with parameters and the documentation is coming from @utrecht/components: [Radio button](https://rijkshuisstijl-community-git-chore-utre-1cc52e-nl-design-system.vercel.app/?path=/docs/rhc-radio--docs) --------- Co-authored-by: Ruben Smit <[email protected]>
Deze is afhankelijk van: #1009.
Context
Op dit moment kunnen wij nog geen README files per component inladen. We hebben nu de README van Utrecht gekopieerd en geplakt in onze eigen
.mdfiles.Oplossingsrichting
Verander voor 1 component de README zodat we weten hoe wij Utrecht README per component kunnen inladen.
The text was updated successfully, but these errors were encountered: