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

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
react, three.js, typescript
Domain
documentation

Research direction

Read README.md around the Quickstart and Gates sections, then check docs/ROADMAP.md and docs/OPEN_TOPICS.md for the intended links. Run npm test and compare its output with the asserted counts before updating the README's status snapshot; done when the stale 43 is corrected or removed, the new section includes only verified counts, and it points to the plan.

Written by the indexing model from the issue text.

Description

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.

Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
1h 28m
Merged PRs (30d)
47

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

All issues in danielw-sudo/agentuto

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.