Updated API guidance to recommend official clients first:#820
Updated API guidance to recommend official clients first:#820vishnandaman wants to merge 4 commits intoibutsu:mainfrom
Conversation
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates documentation to prioritize recommending the official API client over raw curl examples, cleans up duplicated guidance in the JUnit UI subsection, and introduces/updates a widgets user-guide page. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/source/user-guide/widgets.rst" line_range="23-24" />
<code_context>
+-------------------------------------
+
+#. With a project and dashboard selected, click **Add Widget**.
+#. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that
+ type (for example Jenkins job name, number of builds, or grouping field).
+#. Save. The widget appears on the grid; use the actions on the widget card to **edit** or
+ **delete** it later.
</code_context>
<issue_to_address>
**nitpick (typo):** Optional grammar tweak: add a comma after "for example" for smoother reading.
Specifically, in this sentence: "for example, Jenkins job name, number of builds, or grouping field." This is optional polish only.
```suggestion
#. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that
type (for example, Jenkins job name, number of builds, or grouping field).
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| #. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that | ||
| type (for example Jenkins job name, number of builds, or grouping field). |
There was a problem hiding this comment.
nitpick (typo): Optional grammar tweak: add a comma after "for example" for smoother reading.
Specifically, in this sentence: "for example, Jenkins job name, number of builds, or grouping field." This is optional polish only.
| #. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that | |
| type (for example Jenkins job name, number of builds, or grouping field). | |
| #. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that | |
| type (for example, Jenkins job name, number of builds, or grouping field). |
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project check has failed because the head coverage (73.40%) is below the target coverage (85.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #820 +/- ##
=======================================
Coverage 73.40% 73.40%
=======================================
Files 154 154
Lines 7557 7557
Branches 660 660
=======================================
Hits 5547 5547
Misses 1790 1790
Partials 220 220 Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
I have updated the code to recommend the api-client first before raw curl example
and removed the duplicated sentence in the JUnit UI subsection
Summary by Sourcery
Update API usage documentation to prioritize official client guidance and clean up related user guide content.
Documentation: