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

CRAVEX-Docs: Improve documentation

Abierto
  • ¿Algo no está bien?
#27 15 comentarios 0 reacciones 1 asignado Ver en GitHub

@pombredanne ya está trabajando en esto.

Desde el 28/5/2026.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
javascript, markdown, wordpress
Área
content, documentation, web-dev

Línea de trabajo

Comienza inventariando el contenido existente de Docusaurus/Markdown en el repositorio www.aboutcode.org y los sitios actuales de WordPress y Read the Docs/Sphinx descritos en el issue. Define un pequeño incremento de documentación con un resultado específico de getting started antes de cambiar nada; el trabajo estará terminado cuando haya una guía o un tutorial publicado que pueda recibir comentarios de la comunidad.

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

Descripción

documentation

We need improve the user experience in getting started with DejaCode and CRAVEX by updating the AboutCode.org website and the documentation of the AboutCode projects. We should also do an overhaul of the AboutCode's information architecture and supporting systems so it's easier to participate and contribute to AboutCode educational materials using a git-based workflow.

The goal of this new documentation issue is to provide a smooth "getting started" experience and comprehensive suite of guides with educational materials (e.g. tutorials) assisting users with CRA compliance using Dejacode CRAVEX features and AboutCode suite overall.

I suggest we execute this in small increments, creating and publishing the improved and new documentation after each increment, including code examples and other improvements as needed, closing each increment with a blog post that summarizes the new documentation so that we can get community feedback. For this let's track these issues:

Discussed also in https://github.com/orgs/aboutcode-org/discussions/195

Originally posted by pombredanne May 22, 2025
Hey, we need to up our game on the overall project docs and web site as I have received a lot of less positive feedback
Right now aboutcode.org is using wordpress and elementor
And the read the doc web sites are using Restructured text and Sphinx

The issues to me are:

  • we can change the look and feel, but more importantly is the "architecture" of the information about the overall project and how to get started that is the most pressing issue
  • we will need something that's based on text files in git repos, rather that wordpress which does not help much with participation

Inputs and suggestions and help are mucho welcomed. I am considering organizing a commando hackathon thing to get us started.

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

  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 aboutcode-org/www.aboutcode.org

Todos los issues de aboutcode-org/www.aboutcode.org

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.