Merged
Conversation
|
🪓 PR closed, deleted preview. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR primarily improves developer-facing documentation by correcting typos/grammar and reformatting many TypeDoc/JSDoc examples, plus adds convenience scripts for generating library docs/examples.
Changes:
- Fixes wording/grammar and formatting in Markdown docs and TypeScript doc comments.
- Updates many doc examples to use
json-labeled code fences. - Adds
generate-library-docsandgenerate-library-examplesnpm scripts, and fixes an example studyhelpTextPath.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| typedocReadMe.md | Cleans up formatting/typos in generated reference index. |
| src/store/types.ts | Improves wording and reformats StoredAnswer documentation examples. |
| src/storage/types.ts | Refines ParticipantData documentation and comments. |
| src/parser/types.ts | Large set of docstring/example formatting updates across schema types. |
| public/example-llm-chatbot/config.json | Fixes uiConfig.helpTextPath to point at the correct study directory. |
| package.json | Adds scripts to run the library doc/example generators. |
| README.md | Fixes typos/capitalization and punctuation in the project README. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.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
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.
No description provided.