Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Onjuiste en inconsistente documentatie (over Utrecht-componenten) #365

Open
3 tasks
AlineNap opened this issue Feb 4, 2025 · 0 comments
Open
3 tasks
Labels
documentation Improvements or additions to documentation

Comments

@AlineNap
Copy link
Contributor

AlineNap commented Feb 4, 2025

Omschrijving

Momenteel staat overal documentatie van de Utrecht-componenten, maar deze komt niet altijd overeen met wat wij als LUX willen. Daarnaast:

  • Ontbreken er links of componenten waarnaar verwezen wordt. Bij de button staat bijvoorbeeld iets over het component button die eruit ziet als link die wij (nog) niet aanbieden.
  • Verschilt de documentatie soms tussen de webcomponenten en React-componenten, met name de voorbeelden van de varianten en States.
  • Worden keuzes uit Utrecht-documentatie niet altijd door LUX overgenomen.

Dit leidt tot verwarring en onnodig leeswerk bij onze gebruikers.

Verwacht gedrag

  • Utrecht-documentatie wordt alleen behouden waar deze relevant is voor LUX. Of we verwijzen er naar met opmerking dat wij nog met eigen documentatie komen.
  • Inconsistente of ontbrekende documentatie wordt aangepakt.
  • Er wordt een strategie bepaald voor documentatiebeheer binnen LUX.

Acceptatiecriteria

  • Utrecht-documentatie wordt verwijderd (waar deze niet aansluit op LUX.)
  • Er is duidelijkheid over hoe en waar documentatie wordt vastgelegd.
  • Webcomponenten- en React-documentatie komen inhoudelijk overeen.
@AlineNap AlineNap added the documentation Improvements or additions to documentation label Feb 4, 2025
@AlineNap AlineNap changed the title Onjuiste en inconsistente documentatie over Utrecht-componenten 🐛 Onjuiste en inconsistente documentatie over Utrecht-componenten Feb 4, 2025
@AlineNap AlineNap changed the title 🐛 Onjuiste en inconsistente documentatie over Utrecht-componenten 🐛 Onjuiste en inconsistente documentatie (over Utrecht-componenten) Feb 4, 2025
@AlineNap AlineNap moved this to To do in LUX componenten Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: To do
Development

No branches or pull requests

1 participant