Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

CRAVEX-Docs: Improve documentation

Ouverte
  • Quelque chose ne va pas ?
#27 15 commentaires 0 réactions 1 personne assignée Voir sur GitHub

@pombredanne y travaille déjà.

Depuis le 28/5/2026.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
À clarifier
Activité
À l'abandon
Stack technique
javascript, markdown, wordpress
Domaine
content, documentation, web-dev

Piste de recherche

Commencez par inventorier le contenu Docusaurus/Markdown existant dans le dépôt www.aboutcode.org ainsi que les sites WordPress et Read the Docs/Sphinx actuels décrits dans l’issue. Définissez une petite évolution de la documentation avec un résultat précis pour la prise en main avant de modifier quoi que ce soit ; le travail sera terminé lorsqu’un guide ou un tutoriel publié pourra recevoir les retours de la communauté.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
JavaScript
Étoiles
9
Forks
17
Merge moyen
7 h 55 min
PR mergées (30 j)
2

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de aboutcode-org/www.aboutcode.org

Toutes les issues de aboutcode-org/www.aboutcode.org

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.