Skip to content

update docs for jriver and kick #1206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 22, 2025
Merged

update docs for jriver and kick #1206

merged 3 commits into from
Jun 22, 2025

Conversation

aw-was-here
Copy link
Collaborator

@aw-was-here aw-was-here commented Jun 22, 2025

Summary by Sourcery

Update the project's documentation for Jriver and KickBot and adapt CI workflows to use the new documentation build script.

Enhancements:

  • Use a dedicated CI documentation build script for GitHub Pages workflows

Build:

  • Rename docs build command in ghpages-main and ghpages-test workflows to use build-ci-website.sh

CI:

  • Update GitHub Actions workflows to call build-ci-website.sh instead of build-website.sh for docs deployment

Documentation:

  • Refresh Jriver input documentation
  • Refresh KickBot output documentation

Copy link

sourcery-ai bot commented Jun 22, 2025

Reviewer's Guide

Replaces the GitHub Actions website build script with the new build-ci-website.sh and refreshes documentation for the JRiver input and Kick output plugins, including an updated Kick UI resource file.

File-Level Changes

Change Details Files
Switch GitHub Actions site build to new CI script.
  • Replace build-website.sh with build-ci-website.sh in ghpages-main.yaml
  • Replace build-website.sh with build-ci-website.sh in ghpages-test.yaml
.github/workflows/ghpages-main.yaml
.github/workflows/ghpages-test.yaml
Refresh JRiver input plugin documentation.
  • Revise plugin overview and setup steps
  • Update code examples and option descriptions
docs/input/jriver.rst
Refresh Kick output plugin documentation.
  • Revise integration guide
  • Update configuration parameters
docs/output/kickbot.rst
Update Kick UI resource file.
  • Refresh UI layout definitions
  • Adjust resource identifiers
nowplaying/resources/kick_ui.ui

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

@aw-was-here aw-was-here marked this pull request as ready for review June 22, 2025 12:02
Copy link

@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 @aw-was-here - I've reviewed your changes and they look great!

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

### Comment 1
<location> `docs/input/jriver.rst:45` </location>
<code_context>

-#. Note the **Port** number (default is 52199)
+.. image:: images/jriver-advanced-port.png
+   :target: images/jjriver-advanced-port.png
+   :alt: JRiver Advanced drop down showing the port
+
</code_context>

<issue_to_address>
Typo in image path: 'jjriver' should be 'jriver'.

Please update the target path to 'jriver-advanced-port.png' to match the correct image name.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
.. image:: images/jriver-advanced-port.png
   :target: images/jjriver-advanced-port.png
   :alt: JRiver Advanced drop down showing the port
=======
.. image:: images/jriver-advanced-port.png
   :target: images/jriver-advanced-port.png
   :alt: JRiver Advanced drop down showing the port
>>>>>>> REPLACE

</suggested_fix>

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 on lines 44 to 46
.. image:: images/jriver-advanced-port.png
:target: images/jjriver-advanced-port.png
:alt: JRiver Advanced drop down showing the port
Copy link

Choose a reason for hiding this comment

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

issue (typo): Typo in image path: 'jjriver' should be 'jriver'.

Please update the target path to 'jriver-advanced-port.png' to match the correct image name.

Suggested change
.. image:: images/jriver-advanced-port.png
:target: images/jjriver-advanced-port.png
:alt: JRiver Advanced drop down showing the port
.. image:: images/jriver-advanced-port.png
:target: images/jriver-advanced-port.png
:alt: JRiver Advanced drop down showing the port

Copy link

codecov bot commented Jun 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.38%. Comparing base (92aee8b) to head (e1d4f62).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1206      +/-   ##
==========================================
+ Coverage   66.35%   66.38%   +0.02%     
==========================================
  Files          63       63              
  Lines       10741    10741              
==========================================
+ Hits         7127     7130       +3     
+ Misses       3614     3611       -3     
Flag Coverage Δ
unittests 66.38% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@aw-was-here aw-was-here merged commit ec83fa5 into main Jun 22, 2025
3 of 10 checks passed
@aw-was-here aw-was-here deleted the doc_updates branch June 22, 2025 12:48
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