docs(cli): slim package README + correct CLI guide/reference#129
Merged
Conversation
|
Remove the walkthrough, flags table, metadata-options example, and data-file requirements that now duplicate docs/cli-guide.md and cli-reference.md. Keep a quick start (with the Node.js prerequisite up front), a project-structure sketch, a Documentation section linking to the docs/ guides, and the dev "run locally" note. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- CSV inputs are copied to data/ but not additionally duplicated under data/raw/; only JSON/JSONL originals are preserved there. Fix the "What you get" tree and the accepted-formats note accordingly. - Document the top-level .psychds-ignore written when raw originals are preserved, and that nested arrays produce sidecar CSVs. - --data-dir accepts .csv, .json, or .jsonl. - Non-interactive mode: join keys are resolved automatically; the tool also runs without prompting when not attached to a TTY. - Use my-experiment as the example project name and mark it as an example. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The project-structure tree showed data/raw/ unconditionally, contradicting the corrected cli-guide.md/cli-reference.md in this same PR: CSV inputs are written straight to data/ and a CSV-only dataset has no data/raw/ folder. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
jodeleeuw
force-pushed
the
docs/cli-materials
branch
from
341bc2c to
d096639
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR 2 — CLI docs follow-up (stacked on #127)
Stacked on
docs/reorganize-user-guides(#127). Base that PR first; this one shows only the CLI-specific changes.packages/cli/README.md— slimmed to intro + linksRemoved the walkthrough, flags table, metadata-options example, and data-file requirements that now duplicate
docs/cli-guide.mdanddocs/cli-reference.md. Kept a quick start (with the Node.js prerequisite up front), a project-structure sketch, a Documentation section linking to thedocs/guides, and the dev "run locally" note. 144 → ~45 lines.docs/cli-guide.md+docs/cli-reference.md— accuracy correctionsReviewed both against the current CLI implementation and made targeted fixes:
data/raw/. CSVs are copied todata/(their final tabular form is the preserved copy); only JSON/JSONL originals are kept underdata/raw/. The old "What you get" tree wrongly showed the CSV example files underraw/. (cli/src/data.ts:421— raw block is gated onif (parsed), set only for JSON/JSONL.).psychds-ignore— documented the top-level file written when raw originals are preserved (data.ts:554-559), plus that nested arrays produce sidecar CSVs.--data-diraccepts.csv,.json, or.jsonl(was ".csvor.json";data.ts:12-13).index.ts:742-749), and the tool also runs without prompting when not attached to a TTY (index.ts:730).flanker-studytomy-experiment, and marked explicitly as an example.No new recipes/troubleshooting/
--helpcontent, and no CLI runtime changes — docs only.🤖 Generated with Claude Code