Correct documentation errors #328
Open
johnstairs wants to merge 2 commits into
Open
Conversation
… and database management guides
There was a problem hiding this comment.
Pull request overview
This PR corrects typos and command/example inaccuracies across the Tyger documentation and related config templates, improving clarity and aligning docs with the current CLI surface.
Changes:
- Fixes typos/grammar and improves wording throughout introductory and guide docs.
- Corrects CLI command examples/flags (e.g., migration logs command, login flags, TTL format, codespec show usage).
- Fixes incorrect documentation links and standardizes “Optionally” spelling in config templates.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/database-management.md | Fixes wording and corrects migration logs command example. |
| docs/introduction/what-is-tyger.md | Fixes grammar in buffer description. |
| docs/introduction/installation/installation.md | Fixes Docker installation guide link. |
| docs/introduction/installation/docker-installation.md | Fixes step numbering and multiple typos/phrasing issues. |
| docs/introduction/installation/cloud-installation.md | Fixes typos/phrasing and corrects a command reference. |
| docs/guides/runs.md | Fixes typos/grammar in run guide. |
| docs/guides/login.md | Aligns login docs with actual CLI flags and fixes a broken URL. |
| docs/guides/ephemeral-buffers.md | Fixes grammar in ephemeral buffer guide. |
| docs/guides/distributed-runs.md | Fixes typos and wording in distributed runs guide. |
| docs/guides/codespecs.md | Fixes typos and corrects ffmpeg args examples and codespec show usage. |
| docs/guides/buffers.md | Fixes typos and corrects TTL format documentation. |
| deploy/config/microsoft/cloudconfig.yml | Fixes spelling in a comment (“Optionally”). |
| deploy/config/microsoft/cloudconfig-private-link.yml | Fixes spelling in a comment (“Optionally”). |
| cli/internal/install/cloudinstall/cloud-config-pretty.tpl | Fixes spelling in a template comment (“Optionally”). |
Comment on lines
84
to
+86
| [Gadgetron | ||
| examples](../reference/gadgetron/gadgetron.md#distributed-reconstruction) has an | ||
| example that uses a disributed run. | ||
| examples](../reference/gadgetron/gadgetron.md#distributed-reconstruction) include an | ||
| example that uses a distributed run. |
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.
Correcting a number of errors and typos in the documentation