Doc: Extend workshop description, add review config#447
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR extends workshop descriptions throughout the documentation and adds GitHub Copilot review configuration. The changes focus on improving consistency and clarity in workshop terminology while providing better context for development workflows.
Key changes:
- Standardizes workshop descriptions as "development environments running in containers"
- Fixes reference links to use the correct
exp_interfacestarget - Adds comprehensive GitHub Copilot review instructions for documentation changes
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorial/sketch-sdks.rst | Fixes reference link to interfaces explanation |
| docs/tutorial/get-started.rst | Updates workshop description for consistency |
| docs/tutorial/craft-sdks.rst | Adds explanation about sudo -u workshop usage |
| docs/reference/workshops.rst | Standardizes workshop description and fixes grammar |
| docs/reference/index.rst | Minor wording improvement for SDK-workshop relationship |
| docs/reference/definition-files/workshop-definition.rst | Clarifies hidden file naming convention |
| docs/reference/definition-files/sdk-definition.rst | Updates SDK file location descriptions |
| docs/explanation/workshops/index.rst | Fixes reference link to interfaces |
| docs/explanation/workshops/concepts.rst | Major expansion of workshop concepts with detailed explanations |
| docs/explanation/sdks/index.rst | Fixes reference link to interfaces |
| docs/explanation/sdks/concepts.rst | Fixes reference link to interfaces |
| docs/explanation/interfaces/index.rst | Updates reference target from exp_interface to exp_interfaces |
| docs/explanation/index.rst | Standardizes workshop description |
| docs/explanation/architecture/installation.rst | Adds reference anchors for daemon, storage, and images sections |
| .github/copilot-instructions.md | Adds comprehensive GitHub Copilot review configuration |
Contributor
Author
|
@dmitry-lyfar can you please review and approve? |
Collaborator
dmitry-lyfar
left a comment
dmitry-lyfar
left a comment
There was a problem hiding this comment.
Nice. I'd like to suggest some changes (see the comments).
dmitry-lyfar
approved these changes
Aug 21, 2025
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.