DOCS: Create AboutCode doc system
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
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- javascript, markdown
- Área
- documentation
Línea de trabajo
Comienza revisando la documentación existente en aboutcode.readthedocs.io/ y el framework Diátaxis enlazado en el issue. Define la estructura propuesta y las directrices para la documentación del proyecto, los archivos README, los archivos CONTRIBUTING y las descripciones de los repositorios; se considera completado cuando el sistema de documentación esté publicado y explique cómo deben aplicarlo los proyectos de AboutCode.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
To improve and standardize the documentation across AboutCode projects, we plan to implement a documentation system on https://aboutcode.readthedocs.io/. This system will consist of pages inspired by the Divio documentation system, which explains the Diátaxis framework and its application to AboutCode projects.
Beyond outlining how project docs should be structured it the docs system should also provide guidance on README, CONTRIBUTING and repository descriptions.
- Lenguaje dominante
- JavaScript
- Estrellas
- 9
- Forks
- 17
- Merge medio
- 7 h 55 min
- PR fusionados (30 d)
- 2
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 aboutcode-org/www.aboutcode.org
-
Making all post button.Posiblemente ocupada @sarthaklole la tomó hace 71 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
aboutcode-org/www.aboutcode.org#117 · 3 comentarios ·
-
WWW: Reduce frequency of update-releasesQuizá libre de nuevo @johnmhoran la tomó hace 52 días y no hay ningún pull request abierto. Abiertoci-workflow
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
aboutcode-org/www.aboutcode.org#180 · 1 asignado ·
-
DOCS: Create new AboutCode stack diagram(s)Quizá libre de nuevo @hixvikas la tomó hace 53 días y no hay ningún pull request abierto. Abiertodocumentation
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
aboutcode-org/www.aboutcode.org#166 · 1 comentario ·
-
WWW: Create About top level page?Posiblemente ocupada @pombredanne la tomó hace 155 días. Abiertowebsite
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
aboutcode-org/www.aboutcode.org#164 · 1 reacción · 1 asignado ·
-
WWW: Add Initiatives and grant ProjectsQuizá libre de nuevo @mjherzog la tomó hace 242 días y no hay ningún pull request abierto. Abiertoenhancement needs design website
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
aboutcode-org/www.aboutcode.org#141 · 1 asignado ·
Todos los issues de aboutcode-org/www.aboutcode.org
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
agent bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
-
bug 🐛
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
comunica/comunica#1925 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
factory-active task-identify-harness-labels-done task-identify-issue-type-done
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
vercel/ai#24302 · 1 comentario ·
Los mantenedores suelen responder en 1 día