Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

docs: the two commands v0.6.0 shipped are undocumented, and three claims contradict the code

Open
  • Is something wrong?
#268 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
node.js, typescript
Domain
cli, documentation

Research direction

Start by comparing the cited docs pages with their implementation references: bin/palee.ts, src/types.ts, src/cli/migrate.ts, src/cli/adopt.ts, and src/engine/dependency.ts. Re-check quoted output strings by searching src/, then replace stale line-number citations with symbol names in the specified docs. Done means items 1–5 match the current code; the explicitly out-of-scope README boundary remains unchanged.

Written by the indexing model from the issue text.

Description

core enhancement priority: medium release: patch

From a docs-vs-code pass over v0.6.0 at c02c114. Each item was checked against the implementing line, not against another document.

Undiscoverable, though shipped in 0.6.0

  1. palee assess — in bin/palee.ts:93-101 and in palee --help (12 commands), absent from docs/02-0-cli-commands.md:63 ("all 11 commands"), absent from the matrix at :78-90, and absent from docs/02-2-review-and-scheduling-commands.md. The only remedy for a false gate has no documentation at all.
  2. palee migrate --relabel-ties — docs/02-1:324-343 still describes migrate as schema-only; the flag appears nowhere in docs/ or planning/ outside CHANGELOG.md.

Contradicted by the code

  1. docs/02-1:64 says --difficulty numeric 1-2 → beginner; src/types.ts:97-99 maps <=1 beginner, <=3 intermediate. A user following the docs gets a different difficulty than they asked for.
  2. docs/02-1:355 lists exit 4 as N/A for migrate; src/cli/migrate.ts:305 returns 4 on a relabel conflict (and :361, :378 on --fix), which docs/02-0:88 already states correctly.
  3. docs/03-2:237 and planning/invariants.md:74 both quote the honest-refusal string as … no README TOC links …; the CLI prints … no chainable order signal … (src/cli/adopt.ts:794). docs/02-1:102 is correct, so INV-46's own page now disagrees with the command it pins.

Also open

  1. docs/03-0:139 and docs/03-2:234 state readiness "verifies all prerequisites … topic_mastery >= 0.70" unconditionally; src/engine/dependency.ts:771 returns early for advisory toc/tie.
  2. depends_on_source is missing from the schema and glossary docs (docs/05-1:59-76, docs/09-glossary.md) although it is persisted frontmatter deciding whether a note gates.
  3. 0.6.0 shipped three behavioural breaks and the release has no Breaking or Migration section (#266).

Deliverable: one docs pass that fixes 1-5 against the current tip, re-checks every quoted output string by grepping it in src/, and drops the stale line-number citations in docs/02-1:58,249 and docs/08-1:70-92 in favour of symbol names. README's Phase-2 commands (palee test, palee tutor) are a known, deliberate boundary and are out of scope here.

Windows 10, Node 24, v0.6.0.

Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
21h 20m
Merged PRs (30d)
176

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

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 Kuldeep2822k/cli

All issues in Kuldeep2822k/cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.