Skip to content

Komponentenbeschreibung in Dokumentation umziehen (damit readme.mds aus Git entfernen) #6978

@deleonio

Description

@deleonio

Ist es möglich die readme.md's nicht mehr einchecken zu müssen?

  1. Alle deutschen Beschreibung aus den readme's der Komponenten in die mdx-Dateinen zu den Komponenten in der Dokumentation (https://github.com/public-ui/public-ui.github.io) verschieben.
  2. Anschließend können alle Komponente-ReadMes aus Komponenten aus Git gelöscht werden.
  3. 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

Labels

docImprovements or additions to documentationmaintenanceRoutine codebase upkeep and management tasks.v3

Type

No type

Projects

Status

✅ Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions