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

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#194 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
82/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
c, markdown, shell
Bereich
documentation

Rechercherichtung

Beginne mit docs/roadmap.md und prüfe jede „Today“-Zelle anhand von .github/workflows/ci.yml, .github/workflows/nightly.yml, docs/internals/scoreboard.md und docs/internals/status.md. Führe sh tools/scoreboard.sh --quick aus, um aktuelle Messwerte zu erhalten; dafür werden clang und llvm-nm benötigt. Aktualisiere nur veraltete Angaben, gib für jede Zahl Datum und Quelle an und führe anschließend make embdoc && ./embdoc check aus; fertig ist die Aufgabe, wenn jede Zelle korrekt ist und die Linkprüfung besteht.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
C
Sterne
1
Forks
2
Ø Merge
20 Std. 55 Min.
Gemergte PRs (30 T.)
73

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus EmbLinkOs/EmbCC

Alle Issues in EmbLinkOs/EmbCC

Ähnliche Issues

Weitere Issues zu C

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.