Add a table of contents page on every documentation.
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 30/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Activo
- Área
- documentation
Línea de trabajo
No se nombran archivos, pruebas ni puntos de entrada. Empieza leyendo la visión del README y revisando cómo está estructurada la documentación del lenguaje y del framework del proyecto; el trabajo estará terminado cuando cada documentación tenga un índice acordado que abarque desde el material introductorio hasta las referencias de funciones o clases.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Feature request
I am suggesting a table of contents on each documentation.
Summary
The table of contents should start with entry into the language or framework, then functional or class reference of it.
This will make sure that everyone getting started on a language has a clear flow of knowledge from easy to expert, then for the experts, functional reference list will be a plus
Examples
lets say we want to create a table of contents for html:
Table of Contents: HTML
What is html ........................................................ 1
Evolution of HTML ............................................ 2
some feature ....................................................... n
Functional References
function one ......................................................... n +2
- Lenguaje dominante
- Ruby
- Estrellas
- 39.5k
- Forks
- 2.6k
- Merge medio
- 1 d 4 h
- PR fusionados (30 d)
- 13
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de freeCodeCamp/devdocs
-
class Data in Ruby 3.2Abiertodocs/improvement
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
freeCodeCamp/devdocs#1989 · 4 comentarios · 4 reacciones ·
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
freeCodeCamp/devdocs#2744 ·
Los mantenedores suelen responder en 1 día
-
feature
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
freeCodeCamp/devdocs#2712 ·
Los mantenedores suelen responder en 1 día
-
Unit test frontend codeAbiertofeature
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
freeCodeCamp/devdocs#2673 ·
Los mantenedores suelen responder en 1 día
-
feature
Dificultad 5/5 Más de una semana Aptitud para principiantes 18/100
freeCodeCamp/devdocs#2669 · 3 comentarios · 3 reacciones ·
Los mantenedores suelen responder en 1 día
Todos los issues de freeCodeCamp/devdocs
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
rubygems/rubygems.org#6895 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
rom-rb/rom-factory#99 ·
-
accessibility
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
slovensko-digital/autogram-portal#370 · 3 comentarios ·
Los mantenedores suelen responder en 21 días
-
needs triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 5 días
-
security
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día