facebook / facebook/docusaurus

New "Glossary" page

Abierto
#7,670 4 comentarios 1 reacción 0 asignados Ver en GitHub
documentation
Lenguaje dominante
TypeScript
Estrellas
66.2k
Forks
10k
Merge medio
1 d 3 h
PR fusionados (30 d)
52

Descripción

### Have you read the Contributing Guidelines on issues?

- [X] I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#reporting-new-issues).

### Description

We should have a dedicated page for all "jargons" used in the Docusaurus site, especially those UI-related. For example:

- Category link
- Category generated index page
- Docs sidebar
- Navbar
- Table of contents
- Footer
- Mobile sidebar (which is just the navbar)
- Mobile secondary menu (the one populated by the doc sidebar)
- Color mode toggle
- Much, much more

As well as some abstract technical terms like:

- Swizzling
- Plugins/themes/presets
- Theme config
- Bundler, transpiler, minifier

The UI-related terms would need some screenshots about which specific regions we are referring to. The aim is to create a unified lexicon in the community and make people's questions less ambiguous. Another gain is that some of these terms are quite hard to translate (for example, "preset" doesn't have a natural Chinese translation), so having a dedicated keyword-definition page allows people to be exposed to these unnatural terms.

This should be unversioned, so it could probably be a standalone Markdown page.

### Self-service

- [X] I'd be willing to address this documentation request myself.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.