Repository navigation
docs: describe the distribution that exists, and point --help at reachable docs - #419
Conversation
…hable docs No compiled binary is built and releases carry no assets, so the README and runtime.md stop promising one. The help's last line named repo-relative docs paths that the installed package does not ship; it now prints the docs URL, and a test fails if the help names a bare docs path or a URL whose path no longer exists in the tree. runtime.md and architecture.md also get the measured runtime floors, the real lockfile name, and what CI actually runs. Closes #403 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
✅ Reviewed — nothing blocking0 actionable comment(s) · grounded on your code 🤖 developerz.ai — automated review, running on your model and your box. |
There was a problem hiding this comment.
Review summary — 5 file(s), 1 finding(s).
Critical 0 · Major 0 · Minor 1 · Nit 0
Docs-only correction PR: removes the nonexistent compiled-binary claim, fixes runtime floors, and points aitm --help at a reachable GitHub docs URL guarded by a new test. Low risk, but one new line in runtime.md misstates how CI installs dependencies.
🤖 developerz.ai review — automated, running on your model and your box. What is this?
Since #405 the node and integration jobs install with bun install --frozen-lockfile, not npm install; the table still said npm, which is what the review bot read when it questioned runtime.md's lockfile row. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Dismissed automatically by developerz.ai (bot): its own earlier approval is superseded by a newer automated review of this pull request, on commit f2fc5fe. No human dismissed this review.
There was a problem hiding this comment.
Review summary — 1 file(s), 0 finding(s).
This increment updates CLAUDE.md's CI table so the node and integration jobs show bun install --frozen-lockfile instead of npm install, matching what the author reports ci.yml has done since #405. It is a docs-only change, low risk, and nothing visible contradicts it.
- test files were not shown to the reviewer — this diff touched no path recognised as a test, so no assertion was available to read the change against
🤖 developerz.ai review — automated, running on your model and your box. What is this?
What
The documentation now describes the distribution that exists, and
aitm --helppoints at docs a reader can reach.bun build --compilesingle-file binary" now reads "Plain ESM, published to npm".runtime.mddrops thebun build --compilerow and its Distribution row says no binary is built.--help. The last line named four repo-relative paths (docs/commands/start.md, …). The installed package ships no docs directory, and the paths don't resolve from the user's working directory either. It now printsDocs: https://github.com/developerz-ai/ai-task-master/tree/main/packages/aitm/docs/commands, which answers 200 and covers all five command docs (the old line left outupdate.md).help: points at docs a reader can reach, and that still existfails if the help names a baredocs/…path, names no URL, or names a URL that isn't on this repo'smaintree or whose path no longer exists in the checkout. So moving the docs fails here instead of leaving the help pointing at a 404.While in
runtime.md, I corrected four more statements that were false:bun.lock, notbun.lockb);bun testandnode --test(it deliberately runs nobun test, per CLAUDE.md and Support thenode:testbuilt-in API oven-sh/bun#5090);architecture.md, the same runtime floor.The manifest's
fileslist is unchanged on purpose: the package keeps shipping onlydist, the README and the licence, and the help points at the web docs instead (criterion 3).Verification
help.test.tsunder Node: 6/6. Under Bun: 6 pass, 0 fail.main'shelp.tsthe new test fails ("help names a repo-relative docs path"). With the URL pointed at a path that doesn't exist, it fails naming that URL.aitm --helpends with the new URL.bun run lint,bun run typecheck,bun run typecheck:tests: clean. 0 broken relative links outsidedocs/vendor/.Closes #403
🤖 Generated with Claude Code