README: add a Current status section with verified counts (fixes stale 43)

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#63 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ó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
88/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ệ
react, three.js, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc README.md quanh các mục Quickstart và Gates, sau đó kiểm tra docs/ROADMAP.md và docs/OPEN_TOPICS.md để xác định các liên kết dự kiến. Chạy npm test và so sánh kết quả với các số lượng được nêu trước khi cập nhật ảnh chụp trạng thái trong README; hoàn tất khi số 43 đã cũ được sửa hoặc xóa, mục mới chỉ gồm các số lượng đã xác minh và trỏ đến kế hoạch.

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

Mô tả

Trigger: README.md:42 (Quickstart) says npm test runs "43 checks"; the Gates section says 55. Verified independently on 91fb6719 (npm test, exit 0, 55 passing checks): 55 is right, 43 is stale.

Proposal: instead of only fixing the number, add a short "Current status" section to the README — a snapshot of what has shipped, with counts, plus a pointer to the plan:

  • 17 sandboxes (12 2D, 5 Three.js/WebGL), 6 courses, 4 fixed pages
  • 55 checks (npm test), browser smoke test, bundle budget (first load 106.3 kB gzip)
  • Optional Socratic tutor on the user's own Gemini key; everything works without it

Rules for the section (so it does not become a second roadmap or a second source of truth):

  • Every number in it is a number the gates already assert (17 sandboxes / 6 courses / 4 pages are asserted by the address and course checks; 55 by the suite itself). If a count cannot be tied to a check, it does not go in.
  • The plan stays in docs/ROADMAP.md; the section links to it and does not duplicate it. Open items live in ROADMAP §4 / docs/OPEN_TOPICS.md.
  • When a count changes, the section changes in the same PR (roadmap rule: never leave a number in a doc that a check can contradict).

Acceptance: Quickstart number corrected (or removed in favour of the section); section added; counts match npm test output on main.

Filed by Muse (independent auditor) at the owner's instruction, as a first access test.

Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
1 giờ 28 phút
Pull request đã merge (30 ngày)
47

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 danielw-sudo/agentuto

Tất cả issue của danielw-sudo/agentuto

Issue tương tự

Thêm issue về TypeScript

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.