Skip to content

Improve Setup section with beginner-friendly installation steps#1072

Open
Nikita2106-05 wants to merge 1 commit intofossasia:masterfrom
Nikita2106-05:patch-8
Open

Improve Setup section with beginner-friendly installation steps#1072
Nikita2106-05 wants to merge 1 commit intofossasia:masterfrom
Nikita2106-05:patch-8

Conversation

@Nikita2106-05
Copy link

@Nikita2106-05 Nikita2106-05 commented Mar 20, 2026

Description

This PR improves the "Setup" section in the README by making it more beginner-friendly and easier to follow.

Changes

  • Added step-by-step installation instructions
  • Included instructions to start the Visdom server
  • Added guidance on accessing the dashboard
  • Included a simple example for first-time users

Impact

This will help new users and contributors quickly understand how to install and run Visdom locally without confusion.

Type of Change

  • Documentation update

Summary by Sourcery

Documentation:

  • Clarify and simplify the README setup instructions with a step-by-step local installation guide using pip.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 20, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Refines 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

Change Details Files
Clarify and reformat the Setup section to present a beginner-friendly, step-by-step pip installation instruction.
  • Added an introductory sentence explaining that the Setup section is a step-by-step guide for local installation and running Visdom.
  • Introduced a new subheading for the first step of installation (Install Visdom).
  • Replaced the terse 'Install from pip' line and shell-style prompt with a plain pip install command block suitable for copy-paste.
README.md

Possibly linked issues

  • #Improve installation instructions for new contributors: PR updates README Setup with pip install, server start, dashboard access, and simple example as requested in issue.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • 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.
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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant