Add Psych-DS metadata + DataPipe docs under Learn - #1
Open
Mandyx22 wants to merge 9 commits into
Open
Conversation
Port the jspsych/metadata Markdown docs into a "Psych-DS metadata" group under Learn > Guides > Collect & manage data (what-is-psych-ds, getting-started, web wizard, CLI guide, CLI reference, options file), plus a parallel DataPipe page that summarizes DataPipe's automatic metadata generation and links out to pipe.jspsych.org and the metadata pages. The web wizard is documented as a run-locally app since it is not yet deployed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Port DataPipe's web docs (pipe.jspsych.org) into a DataPipe sub-group parallel to Psych-DS metadata: overview, getting started, API reference, metadata, and FAQ. Content mirrors the DataPipe site; cross-links point to the metadata pages here and out to pipe.jspsych.org for the full docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Drop the four DataPipe FAQ items that duplicated Getting started / API reference (how to use, base64, condition assignment, metadata production); keep the operational ones (cost, storage/retries, 32 MB limit, risks, one-click auth, citation). - Shrink the repeated "What is Psych-DS?" section in metadata getting started to a pointer to the dedicated page. - Defer the CLI guide's exhaustive accepted-formats and file-renaming tables to the CLI reference. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Remove the Further reading section from What is Psych-DS? - Rename the CLI guide page/label to "Using the CLI" (title "Using the metadata CLI") for parity with "Using the web wizard", and update the cross-reference link text on the three pages that point to it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Drop the "DataPipe — " em-dash prefix from the DataPipe frontmatter titles so they match their on-page H1s and the metadata group's self-contained title style. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ta page - Move the DataPipe sub-group above Psych-DS metadata under Collect & manage data. - Rename the DataPipe metadata page to "Metadata with DataPipe" (sidebar label, frontmatter title, and heading). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Merge the five DataPipe pages into one page (like the sibling eye-tracking guide), navigable via the right-hand table of contents: What is DataPipe? / How it works / Getting started / Sending data / Metadata with DataPipe / Good to know. Sections are trimmed to summary level and link out to pipe.jspsych.org for the full API and FAQ. The FAQ page is dropped; its few unique, operational facts (free, no data storage, 32 MB limit, hosting, citation) move into "Good to know". The sidebar DataPipe category becomes a single doc entry above the Psych-DS metadata group. The metadata group is unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Reword the DataPipe tip box to focus on using DataPipe itself (drop the Psych-DS metadata framing) and point to the full docs. - Link the DataPipe API reference directly to pipe.jspsych.org/api-docs. - Link the "From the command line" bullet in What is Psych-DS? to Using the CLI, matching the web-wizard bullet. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add inbound links from existing docs to the new DataPipe and metadata pages so readers can discover them in context: - storing-data: mention DataPipe in the intro + new "Sending data to a hosted service" section - running-experiments: add DataPipe to the hosting/data-saving options - plugin-components / extension-development: link "experiment metadata" and "Psych-DS standard" to the metadata guide (and fix adjacent typos) - rt-task: add a "Next steps" section pointing to storing-data/DataPipe Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
What this adds
New documentation under Learn → Guides → Collect & manage data, next to Storing and exporting data:
DataPipe — a single page (like the sibling Eye tracking guide), navigated via the right-hand table of contents:
It's summary-level and links out to pipe.jspsych.org (and
/api-docs) for the full, always-current API and FAQ.Psych-DS metadata — a sub-group porting the Markdown docs from
jspsych/metadata, which has no rendered doc site yet:The two are cross-linked (DataPipe → the metadata pages, and the metadata pages note that DataPipe can generate this automatically).
Discoverability: inbound links from existing pages
So the new pages aren't dead ends, existing docs now link into them where a reader would naturally look for data-saving or metadata:
Notes for review
packages/frontendinjspsych/metadata) isn't deployed yet, so it's documented as a run-locally app rather than a hosted link. The hosted Psych-DS web validator is linked where relevant.npm run buildpasses; no broken links originate from the new pages.🤖 Generated with Claude Code