Doc: Use real-life workshop examples#946
Open
akcano wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Workshop documentation to replace fictional SDK/interface examples with a more realistic “notebook” workshop scenario, aligning reference and conceptual docs with the newer SDK ecosystem and interfaces usage.
Changes:
- Replaced the older
tensorflow/imagenet/cudaexample with anollama/uv/jupyter-based workshop example, including updated narrative andliteralinclude. - Clarified mount interface semantics around directory creation/existence for plugs vs slots.
- Added a new
workshop-notebook.yamlexample and removed the deprecatedworkshop-digits-cuda.yaml, plus updated the docs custom wordlist accordingly.
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/reference/definition-files/workshop-definition.rst | Switches the referenced workshop example to the new notebook scenario and updates explanatory text. |
| docs/reference/definition-files/_interfaces/mount.rst | Adds clarifications about mount target/source directory behavior (creation vs preexistence). |
| docs/explanation/workshops/concepts.rst | Updates the conceptual grafting/connections example to use the new SDKs and tunnel connections. |
| docs/examples/workshop-notebook.yaml | Introduces the new real-life notebook workshop definition example. |
| docs/examples/workshop-digits-cuda.yaml | Removes the old fictional digits/cuda example. |
| docs/.custom_wordlist.txt | Removes an obsolete custom dictionary entry tied to the removed example. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.