Optimize the Readme.md#4
Merged
Merged
Conversation
Signed-off-by: kerthcet <kerthcet@gmail.com>
Member
Author
|
/lgtm |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Moves end-user usage examples out of the root README and into the Quickstart doc, while also updating the README diagram snippet to reflect the current Python import path.
Changes:
- Added a new “Usage Examples” section to
docs/QUICKSTART.md. - Removed the duplicated “Usage Examples” section from
README.md. - Updated/realigned the README architecture diagram snippet (including
from sandd import Server).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/QUICKSTART.md | Adds consolidated usage examples (commands, shell, file transfer, daemon management) to the Quickstart. |
| README.md | Removes the usage examples section and updates the diagram snippet/import path formatting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -115,91 +114,6 @@ print(f"Output: {result.stdout}") | |||
| # ... repeat for n+ machines | |||
| ``` | |||
|
|
|||
| ``` | ||
|
|
||
| ### Interactive Shell | ||
|
|
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.
What this PR does / why we need it
Which issue(s) this PR fixes
Fixes #
Special notes for your reviewer
Does this PR introduce a user-facing change?