Doc: Improve tutorial wording, structure#474
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR improves the tutorial documentation by refining wording, reorganizing content structure, and enhancing clarity throughout multiple tutorial sections. The changes focus on making the documentation more readable and logically structured.
Key changes:
- Reorganized sections in part-3 to better separate exploration commands from SDK conversion workflows
- Improved wording and clarity across multiple tutorial parts
- Enhanced explanations of workshop commands and their usage
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorial/part-4-craft-sdks.rst | Improved explanation of SDK try area usage and channel requirements |
| docs/tutorial/part-3-sketch-sdks.rst | Restructured sections to separate sketch exploration from conversion workflow |
| docs/tutorial/part-2-work-with-interfaces.rst | Enhanced interface connection explanations and added command examples |
| docs/tutorial/part-1-get-started.rst | Clarified workshop definition format and improved change terminology |
| docs/how-to/fix-workshops/resolve-plug-conflicts.rst | Minor wording improvement for plug conflict explanation |
| .workshop/dev.yaml | Configuration change from 'actions' to 'scripts' key |
There was a problem hiding this comment.
The phrase 'the first possible outcome' creates unclear navigation expectations. Consider revising to 'one option is to convert it' or 'you can convert it' to maintain clarity about available choices without implying a specific sequence.
There was a problem hiding this comment.
The phrase 'the other possible outcome' is awkward and creates artificial sequencing. Consider simplifying to 'you can remove the sketch SDK permanently' to maintain consistency with the documentation style.
No description provided.