Add tutorial section#232
Open
jaykim1213 wants to merge 10 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new tutorial section to the documentation site for installation, config.json, and replication-config.json, with sidebar navigation and supporting tutorial walkthrough content.
Changes:
- Adds new tutorial docs and screenshots for core study configuration workflows.
- Expands installation guidance with prerequisite tooling and cloning steps.
- Updates sidebar navigation and conditionally enables gtag analytics.
Reviewed changes
Copilot reviewed 7 out of 27 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
sidebars.ts |
Adds the Tutorial category under Getting Started. |
docusaurus.config.ts |
Gates gtag configuration behind ENABLE_GTAG. |
docs/tutorial/tutorial.md |
Adds tutorial landing page with embedded video and doc cards. |
docs/tutorial/config.json.md |
Adds step-by-step tutorial for building a study config. |
docs/tutorial/replication-config.json.md |
Adds replication study config tutorial. |
docs/getting-started/installation.md |
Expands setup prerequisites and cloning instructions. |
.github/workflows/deploy.yml |
Removes the existing GitHub Pages deployment workflow. |
Comments suppressed due to low confidence (1)
.github/workflows/deploy.yml:1
- Removing the only workflow that builds and publishes
./buildto GitHub Pages means pushes tomainwill no longer deploy the documentation site. If deployment is still expected for this repo, keep this workflow or replace it with an equivalent Pages deployment workflow in the same change.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
A preview of ffa3968 is uploaded and can be seen here: Changes may take a few minutes to propagate. |
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.
Does this PR close any open issues?
Closes #230
Give a longer description of what this PR addresses and why it's needed
config.json,replication-config.jsonpages)Provide pictures/videos of the behavior before and after these changes (optional)