Repository navigation
Clarify the demo checkout prerequisite - #34
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The change is a consistent, low-risk documentation clarification across locales and matches the actual install flow shown in the same files.
Pull request overview
This PR clarifies the “Try the local demo first” prerequisite in the Quickstart docs so readers don’t assume a package-only installation includes the demo sample files. It updates all six documentation locales to explicitly require cloning the repository and installing the base package before running the demo from the repo root.
Changes:
- Reworded the local demo prerequisite to explicitly require cloning the repo.
- Clarified that users should follow the installation instructions and then run the demo from the cloned repository root.
- Applied the same prerequisite wording consistently across all six locales (en, es, fr, ja, ru, zh-CN).
File summaries
| File | Description |
|---|---|
| docs/en/overview/quickstart.md | Clarifies demo prerequisite to require cloning + installing before running from repo root. |
| docs/es/overview/quickstart.md | Same prerequisite clarification applied to Spanish locale quickstart. |
| docs/fr/overview/quickstart.md | Same prerequisite clarification applied to French locale quickstart. |
| docs/ja/overview/quickstart.md | Same prerequisite clarification applied to Japanese locale quickstart. |
| docs/ru/overview/quickstart.md | Same prerequisite clarification applied to Russian locale quickstart. |
| docs/zh-CN/overview/quickstart.md | Same prerequisite clarification applied to Simplified Chinese locale quickstart. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
The new demo section precedes the installation instructions, so its wording could imply that a package-only installation includes the sample files. Explicitly require cloning the repository and installing the base package before running the demo, in all six documentation locales.
This addresses the review feedback on #31. Validation: checked that all six files contain the corrected prerequisite;
git diff --checkpasses. The Pages build checks the rendered documentation.