Skip to content

docs: add quick start section for beginners#1074

Open
sumedhaagh wants to merge 2 commits intofossasia:masterfrom
sumedhaagh:patch-1
Open

docs: add quick start section for beginners#1074
sumedhaagh wants to merge 2 commits intofossasia:masterfrom
sumedhaagh:patch-1

Conversation

@sumedhaagh
Copy link

@sumedhaagh sumedhaagh commented Mar 21, 2026

Added a Quick Start section in README to help new users quickly install and run Visdom locally.

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code refactor or cleanup (changes to existing code for improved readability or performance)

Checklist:

  • I adapted the version number under py/visdom/VERSION according to Semantic Versioning
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Summary by Sourcery

Documentation:

  • Add a Quick Start guide in the README covering installation, server startup, dashboard access, and a minimal Python usage example.

Added a Quick Start section in README to help new users quickly install and run Visdom locally.
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 21, 2026

Reviewer's Guide

Adds a new 'Quick Start' section to the README that provides a minimal step-by-step guide for installing Visdom, starting the server, accessing the dashboard in a browser, and running a simple Python example.

Flow diagram for Quick Start steps to run Visdom locally

flowchart TD
  A[Read Quick Start section in README] --> B[Install Visdom using pip install visdom]
  B --> C[Start Visdom server using visdom]
  C --> D[Open browser and navigate to http://localhost:8097]
  D --> E[Create and run Python script using visdom.Visdom]
  E --> F[View text and scatter plot in Visdom dashboard]
Loading

File-Level Changes

Change Details Files
Introduce a beginner-friendly Quick Start guide into the README to simplify initial setup and usage.
  • Added a 'Quick Start' heading and brief introductory sentence for new users.
  • Documented pip-based installation command for Visdom.
  • Documented how to start the Visdom server from the command line.
  • Documented the default local URL for accessing the Visdom dashboard.
  • Included a minimal Python example that connects to Visdom, renders text, and creates a scatter plot.
README.md

Possibly linked issues

  • #(unknown): The PR’s Quick Start section adds exactly the step-by-step install, run, and example flow requested in the 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:

  • Consider mentioning any minimum Python/pip version or environment assumptions in the Quick Start (e.g., that pip refers to the same interpreter you’ll run Visdom with) to avoid confusion for new users.
  • You might want to show the server start command with an explicit port and host (e.g., visdom -port 8097 -host 0.0.0.0) and note that http://localhost:8097 is the default URL, so users know how to customize it if needed.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider mentioning any minimum Python/pip version or environment assumptions in the Quick Start (e.g., that `pip` refers to the same interpreter you’ll run Visdom with) to avoid confusion for new users.
- You might want to show the server start command with an explicit port and host (e.g., `visdom -port 8097 -host 0.0.0.0`) and note that `http://localhost:8097` is the default URL, so users know how to customize it if needed.

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.

@sumedhaagh
Copy link
Author

Thanks for the feedback! I've updated the Quick Start section to clarify that pip should correspond to the same Python environment being used.
I've also mentioned the default host and port (localhost:8097) and noted that these can be customized using command line options if needed. Please let me know if any further improvements are required

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