Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[docs] Create documentation for documentation (getting started template, useful tips/tricks)

Abierto
#296 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
38/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
markdown

Línea de trabajo

Localiza la estructura existente de la documentación para desarrolladores y páginas comparables de introducción, y revisa después cómo se usan actualmente el frontmatter y componentes como Since, ValidExample e InvalidExample. Se considera terminado cuando se haya añadido una guía independiente de la versión que cubra la plantilla solicitada, enlaces y consejos de frontmatter, componentes y ejemplos de archivos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation enhancement help wanted
What is the Moodle feature that needs documenting?

For documentation we should document some tips and tricks on getting started, for example:

  • a getting started template
  • useful markdown frontmatter
  • links to the frontmatter docs
  • useful components (Since, ValidExample, InvalidExample)
  • other useful things (including examples from file, etc.)
Is this documentation specific to a Moodle version?

No

Are you able to provide a patch for this?

Yes - I will create one

Lenguaje dominante
TypeScript
Estrellas
74
Forks
652
Merge medio
2 d 50 min
PR fusionados (30 d)
12

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de moodle/devdocs

Todos los issues de moodle/devdocs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.