nl-design-system / documentatie

Website met documentatie van NL Design system: componenten, patronen, richtlijnen etcetera. Development-versie: https://documentatie.vercel.app/
https://www.nldesignsystem.nl/
European Union Public License 1.2
10 stars 12 forks source link

Keywords toevoegen aan componenten-pagina's #1158

Open Robbert opened 3 months ago

Robbert commented 3 months ago

De zoekresultaten in Google en in Algolia zouden sterk verbeterd kunnen worden als we meer steekwoorden documenteren, zodat die terechtkomen in de HTML metadata: <meta name="keywords" content="button, buttons, knop, knoppie"/>

De keywords kunnen een goede basis vormen voor de "ook bekend als" documentatie bij een component.

De keywords moeten zowel Engelse als Nederlandse termen bevatten, die gerelateerd zijn aan de component.

Wanneer de keywords eenmaal zijn geïndexeerd, kunnen we testen of de componenten in de juist volgorde van relevantie worden gevonden. Daarna kunnen we eventueel besluiten bepaalde keywords weer weg te halen bij componenten die onnodig hoog in de resultaten eindigen.

Laat hier in de issue even welke aan welke beginsletter je gaat werken (bijvoorbeeld A-D), zodat we parallel aan keywords kunnen werken zonder dubbel werk te doen.

Rozerinay commented 3 months ago

Ik heb de canvas Keywords componenten aangemaakt waarin ik alle keywords verzamel.