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

Open Beginner friendly
  • Is something wrong?
#194 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
c, markdown, shell
Domain
documentation

Research direction

Start with docs/roadmap.md and check each “Today” cell against .github/workflows/ci.yml, .github/workflows/nightly.yml, docs/internals/scoreboard.md, and docs/internals/status.md. Run sh tools/scoreboard.sh --quick for current measurements; it needs clang and llvm-nm. Update only outdated claims, date and source each number, then run make embdoc && ./embdoc check; done means every cell is accurate and the link check passes.

Written by the indexing model from the issue text.

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.

Dominant language
C
Stars
1
Forks
2
Avg merge
20h 55m
Merged PRs (30d)
73

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EmbLinkOs/EmbCC

All issues in EmbLinkOs/EmbCC

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.