Skip to content

docs: update PSLab app links#284

Open
macayu17 wants to merge 3 commits into
fossasia:mainfrom
macayu17:codex/update-pslab-app-link
Open

docs: update PSLab app links#284
macayu17 wants to merge 3 commits into
fossasia:mainfrom
macayu17:codex/update-pslab-app-link

Conversation

@macayu17
Copy link
Copy Markdown

@macayu17 macayu17 commented May 23, 2026

Fixes #283

Changes

  • Replace the README GUI link from the retired pslab-desktop repo with fossasia/pslab-app.
  • Update the installation docs to use the same PSLab app link.

Testing

  • python -m build
  • tox -e docs
  • tox -e lint
  • git diff --check

I also ran tox -e integration. It fails locally on the current upstream test setup, unrelated to this documentation change:

  • Python 3.13: collection fails in tests/test_spi.py and tests/test_uart.py because _frequency / _baudrate resolve as methods.
  • Python 3.11: tests collect, then fail because pytest-mock is missing and tests/conftest.py calls SerialHandler() without the required port.

Summary by Sourcery

Update documentation to point to the current PSLab GUI application repository.

Documentation:

  • Replace README GUI link from the retired pslab-desktop repository with the current fossasia/pslab-app link.
  • Align installation documentation to reference the updated PSLab app repository link.

Copilot AI review requested due to automatic review settings May 23, 2026 17:01
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 23, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR updates documentation to point from the deprecated pslab-desktop GUI repository to the current PSLab app repository, keeping README and installation docs consistent.

Flow diagram for updated GUI documentation link

flowchart LR
    User["User reads PSLab documentation"] --> DecideGUI["Needs GUI for PSLab"]
    DecideGUI --> InstallPython["Install pslab-python (CLI/acquisition)"]
    DecideGUI --> VisitAppRepo["Open PSLab app repo (fossasia/pslab-app)"]
    VisitAppRepo --> FollowReadme["Follow repo Readme to install GUI app"]
Loading

File-Level Changes

Change Details Files
Update GUI application links in documentation from the deprecated pslab-desktop repo to the current PSLab app repo.
  • Replace the README note’s GUI link target with the fossasia/pslab-app repository and adjust visible link text accordingly.
  • Align the installation documentation to use the same updated PSLab app repository link for GUI usage instructions.
README.md
docs/installation.rst

Assessment against linked issues

Issue Objective Addressed Explanation
#283 Update README.md to replace the outdated pslab-desktop application link with the current PSLab app repository link.

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
Copy Markdown

@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 found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="README.md" line_range="32" />
<code_context>
 **Note**: Windows users who use the PSLab v6 device must download and install the CP210x Windows Drivers from the [Silicon Labs website](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads) in order for pslab-python to be able to communicate with the PSLab device.

-**Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [pslab-desktop app](https://github.com/fossasia/pslab-desktop) and follow the instructions of the Readme in that repo.
+**Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [PSLab app](https://github.com/fossasia/pslab-app) and follow the instructions of the Readme in that repo.


</code_context>
<issue_to_address>
**suggestion (typo):** Consider changing "Readme" to "README" to match the conventional filename.

This will align the reference with the actual filename in the repo and improve clarity for readers.

```suggestion
**Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [PSLab app](https://github.com/fossasia/pslab-app) and follow the instructions of the README in that repo.
```
</issue_to_address>

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.

Comment thread README.md Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates user-facing documentation to point to the current PSLab GUI application and aligns link formatting across RST/Markdown docs.

Changes:

  • Replace the deprecated pslab-desktop link with pslab-app in installation docs.
  • Update README’s GUI note to reference pslab-app.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/installation.rst Switches GUI reference to pslab-app using proper reStructuredText link syntax.
README.md Updates GUI note to link to the pslab-app GitHub repository.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
**Note**: Windows users who use the PSLab v6 device must download and install the CP210x Windows Drivers from the [Silicon Labs website](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads) in order for pslab-python to be able to communicate with the PSLab device.

**Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [pslab-desktop app](https://github.com/fossasia/pslab-desktop) and follow the instructions of the Readme in that repo.
**Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [PSLab app](https://github.com/fossasia/pslab-app) and follow the instructions of the Readme in that repo.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 23, 2026 17:12
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comment thread docs/installation.rst Outdated

**Note**: pslab-python does not provide a graphical user interface. If you want
a GUI, install the [pslab-desktop app](https://github.com/fossasia/pslab-desktop).
a GUI, install the `PSLab app <https://github.com/fossasia/pslab-app>`__.
Comment thread docs/installation.rst Outdated
Comment on lines +20 to +21
``pslab-python`` requires `Python <http://python.org/download/>`__ version
3.6 or later. No newline at end of file
3.6 or later.
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.

README references outdated desktop application

2 participants