Improve Setup section with beginner-friendly installation steps#1072
Open
Nikita2106-05 wants to merge 1 commit intofossasia:masterfrom
Open
Improve Setup section with beginner-friendly installation steps#1072Nikita2106-05 wants to merge 1 commit intofossasia:masterfrom
Nikita2106-05 wants to merge 1 commit intofossasia:masterfrom
Conversation
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideRefines the README Setup section to provide a clearer, step-by-step local installation flow for Visdom using pip, making it more approachable for beginners. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The numbered subheading
### 1. Install Visdomintroduces a list but the subsequent "Install from source" section is left outside that structure; consider either converting all setup paths into a consistent numbered list or removing the numbering to keep the section stylistically uniform. - The original sentence "Python and web clients come bundled with the python server." was removed; if still accurate, it may be useful to keep this clarification somewhere in the Setup section so users understand what gets installed with the package.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The numbered subheading `### 1. Install Visdom` introduces a list but the subsequent "Install from source" section is left outside that structure; consider either converting all setup paths into a consistent numbered list or removing the numbering to keep the section stylistically uniform.
- The original sentence "Python and web clients come bundled with the python server." was removed; if still accurate, it may be useful to keep this clarification somewhere in the Setup section so users understand what gets installed with the package.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Description
This PR improves the "Setup" section in the README by making it more beginner-friendly and easier to follow.
Changes
Impact
This will help new users and contributors quickly understand how to install and run Visdom locally without confusion.
Type of Change
Summary by Sourcery
Documentation: