Skip to content

docs: fix stale Node 18 references → Node 20+ - #264

Open
TerminalGravity wants to merge 4 commits into
mainfrom
fix/node-version-docs
Open

docs: fix stale Node 18 references → Node 20+#264
TerminalGravity wants to merge 4 commits into
mainfrom
fix/node-version-docs

Conversation

@TerminalGravity

Copy link
Copy Markdown
Collaborator

README badge and CONTRIBUTING.md both said Node 18+ but package.json requires >=20 and Node 18 was dropped from CI in #51. Also adds a troubleshooting entry for Node version errors since this is a common footgun.

Shows 4 concrete scenarios: vague prompt clarification, multi-step
scoping, correction pattern matching, and cross-service awareness.
Each example includes the prompt, triage classification, and the
actual output users can expect.
The README and examples/README.md referenced examples/.preflight/
but the actual config files didn't exist. Added:

- config.yml — profile, related projects, thresholds, embeddings
- triage.yml — keyword rules and strictness settings
- contracts/api.yml — manual contract definition examples

All files are heavily commented so users can copy them into their
project root and customize without needing to reference the docs.
The init wizard resolved the templates directory relative to dist/cli/,
which pointed to dist/templates/ — a path that doesn't exist. Templates
live in src/templates/ and ship in the npm tarball via the 'files' field.

Fixed by going up three levels (dist/cli/init.js → package root) instead
of two, then into src/templates/.
…ngines)

- README badge: 18+ → 20+
- CONTRIBUTING.md prerequisites: 18+ → 20+
- Added troubleshooting entry for Node version errors
- Node 18 was dropped from CI in commit 4637eaf

@TerminalGravity TerminalGravity left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heads up — this overlaps with #257 which also fixes Node 18 → Node 20 references. Might want to close one of these to avoid merge conflicts.

@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

This overlaps with #257 (same Node version fix) and is also included in the batch PR #265. Recommend closing this and #257 in favor of #265 which bundles the fix with other changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant