docs: bring the roadmap's "Today" column up to date

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#194 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
82/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
c, markdown, shell
Domaine
documentation

Piste de recherche

Commence par docs/roadmap.md et vérifie chaque cellule « Today » en la comparant à .github/workflows/ci.yml, .github/workflows/nightly.yml, docs/internals/scoreboard.md et docs/internals/status.md. Exécute sh tools/scoreboard.sh --quick pour obtenir les mesures actuelles ; clang et llvm-nm sont nécessaires. Mets à jour uniquement les affirmations obsolètes, indique la date et la source de chaque chiffre, puis exécute make embdoc && ./embdoc check ; le travail est terminé lorsque chaque cellule est exacte et que la vérification des liens réussit.

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

Description

documentation good first issue

Context. docs/roadmap.md says what 1.0 promises, and in its "Today" column how far EmbCC is from each promise. That column was written for 0.0.1-beta (October 2026), and parts of it are no longer true. For example:

  • "No CI on pull requests. The matrix runs on a developer machine." Since #182, every pull request runs the full suite, a fuzz job and check-self (.github/workflows/ci.yml), and the nightly workflow runs GCC's torture suite and more fuzzing (.github/workflows/nightly.yml).
  • The refusal counts (110 backend, 134 front-end) and the code-size ratios (2026-10-24) have newer measurements in docs/internals/scoreboard.md.
  • The documentation row says the status page "still lists C++ as refused on Cortex-M". Check docs/internals/status.md to see whether that is still so.

Where. Only docs/roadmap.md. The facts come from .github/workflows/, docs/internals/scoreboard.md, docs/internals/status.md, and the commands below.

Steps.

  1. For each row, check the "Today" cell against the repository. Run sh tools/scoreboard.sh --quick for the size and refusal numbers. It needs clang and llvm-nm, and takes a few minutes.
  2. Rewrite only what is no longer true, and give the date and source of every number, as the existing cells do.
  3. Run make embdoc && ./embdoc check to make sure every link still resolves.

Done when every "Today" cell is true on main, each number names where it comes from, and ./embdoc check reports no broken links.

Before you start: the contributor's guide has the rules. A new test counts only after it has failed against the code before your change, and a commit subject reads area: summary. Questions are welcome in the comments or in Discussions.

Langage dominant
C
Étoiles
1
Forks
2
Merge moyen
20 h 55 min
PR mergées (30 j)
73

Préparer son environnement

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 EmbLinkOs/EmbCC

Toutes les issues de EmbLinkOs/EmbCC

Issues similaires

Plus d'issues C

Recevez les nouvelles issues par e-mail

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