-
Notifications
You must be signed in to change notification settings - Fork 12
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
Conversation
Reviewer's GuideReplaces 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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>
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
docs/input/jriver.rst
Outdated
.. image:: images/jriver-advanced-port.png | ||
:target: images/jjriver-advanced-port.png | ||
:alt: JRiver Advanced drop down showing the port |
There was a problem hiding this comment.
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.
.. 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 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Summary by Sourcery
Update the project's documentation for Jriver and KickBot and adapt CI workflows to use the new documentation build script.
Enhancements:
Build:
CI:
Documentation: