Doc: Add 'SDK best practices'#483
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive "Design best practices" documentation page for SDK development in Workshop, providing guidance on system services, parts decomposition, interface design, environment variables, hooks usage, health checks, and content sharing patterns.
- Introduces a new explanation document covering SDK design principles and best practices
- Updates the SDK documentation index to include the new best practices page
- Adds the word "uv" to the custom wordlist for spell checking
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/explanation/sdks/index.rst | Adds table of contents entry for the new best practices documentation |
| docs/explanation/sdks/best-practices.rst | New comprehensive guide covering SDK design patterns, implementation strategies, and best practices with concrete examples |
| docs/.custom_wordlist.txt | Adds "uv" to the spell check wordlist to support the new documentation content |
dmitry-lyfar
approved these changes
Sep 16, 2025
dmitry-lyfar
requested changes
Sep 16, 2025
Collaborator
dmitry-lyfar
left a comment
dmitry-lyfar
left a comment
There was a problem hiding this comment.
Left comments after the first pass. I think this also affects the navigation and other design related sections in the docs, let's discuss on the call.
akcano
force-pushed
the
docs/best-practices
branch
from
9bf221c to
295db69
Compare
Collaborator
dmitry-lyfar
left a comment
dmitry-lyfar
left a comment
There was a problem hiding this comment.
Nice, I think we're close.
akcano
force-pushed
the
docs/best-practices
branch
from
f1ed681 to
e594c99
Compare
dmitry-lyfar
approved these changes
Sep 17, 2025
Collaborator
dmitry-lyfar
left a comment
dmitry-lyfar
left a comment
There was a problem hiding this comment.
Looks good, a few more notes to update, but ready to go afterwards.
Co-authored-by: Dmitry Lyfar <69887876+dmitry-lyfar@users.noreply.github.com>
akcano
force-pushed
the
docs/best-practices
branch
from
e594c99 to
83f9233
Compare
dmitry-lyfar
approved these changes
Sep 22, 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.