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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#194 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
c, markdown, shell
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với docs/roadmap.md và đối chiếu từng ô “Today” với .github/workflows/ci.yml, .github/workflows/nightly.yml, docs/internals/scoreboard.md và docs/internals/status.md. Chạy sh tools/scoreboard.sh --quick để lấy số liệu hiện tại; lệnh này cần clang và llvm-nm. Chỉ cập nhật những nhận định đã lỗi thời, ghi ngày và nguồn cho từng con số, rồi chạy make embdoc && ./embdoc check; hoàn thành khi mọi ô đều chính xác và bước kiểm tra liên kết thành công.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
C
Star
1
Fork
2
Merge trung bình
20 giờ 55 phút
Pull request đã merge (30 ngày)
73

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của EmbLinkOs/EmbCC

Tất cả issue của EmbLinkOs/EmbCC

Issue tương tự

Thêm issue về C

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.