-
Notifications
You must be signed in to change notification settings - Fork 43
Closed
Labels
docImprovements or additions to documentationImprovements or additions to documentationmaintenanceRoutine codebase upkeep and management tasks.Routine codebase upkeep and management tasks.v3
Description
Ist es möglich die readme.md
's nicht mehr einchecken zu müssen?
- Alle deutschen Beschreibung aus den
readme
's der Komponenten in diemdx
-Dateinen zu den Komponenten in der Dokumentation (https://github.com/public-ui/public-ui.github.io) verschieben. - Anschließend können alle Komponente-ReadMes aus Komponenten aus Git gelöscht werden.
- Abschließend die Komponente-ReadMes in gitignore eintagen. (
/packages/components/src/components/*/ReadMe.md
)
- die ReadMe im components-Ordner kann auch entfernt werden.
Package: /packages/components/src/components/**
Bspw. muss die Beschreibung von Abbr aus der Readme von Abbr hier in Zeile 15 verschoben werden: https://github.com/public-ui/public-ui.github.io/blob/084dacd4862e2961c46babc57772b0ddd5d24f63/docs/30-components/abbr.mdx?plain=1#L15
Hinweise:
- bei Dokuänderungen gibt es dann zwei PRs: im kolibri- und in den docs-Repo.
- Die Generierung sollte aus dem "Standard"-Build entfernt werden und nur beim erstellen der Doku aktiviert sein
Metadata
Metadata
Assignees
Labels
docImprovements or additions to documentationImprovements or additions to documentationmaintenanceRoutine codebase upkeep and management tasks.Routine codebase upkeep and management tasks.v3
Type
Projects
Status
✅ Done