feat: Make OBS user documentation more visible#19279
feat: Make OBS user documentation more visible#19279Sahitya0805 wants to merge 1 commit intoopenSUSE:masterfrom
Conversation
3344bae to
39b8615
Compare
571c75d to
983b8ed
Compare
|
Please mind https://github.com/openSUSE/open-build-service/blob/master/CONTRIBUTING.md#proper-pull-request Especially:
|
|
I'm not convinced that just adding a second link to the documentation in the upper navigation is helping anything. Other opinions? |
|
Thanks for the feedback, that makes sense Instead of adding a new icon, I can try some simpler options: • Add the documentation link inside an existing menu (like the user dropdown or settings) so it’s easier to find without adding extra UI I’m happy to update the PR in whichever way fits the project best |
|
What would make most sense is to add links to relevant sections of the documentation to certain pages. Like adding a link to the Build Configuration section to the |
983b8ed to
a111ce3
Compare
|
Thanks for the feedback! I’ve updated the PR and replaced the global help icon with a contextual documentation link on the project configuration page. |
|
Thanks for the update, this looks like the right direction The contextual documentation link on the project configuration page makes sense and feels more intuitive than the global help icon. Yes, please go ahead and apply the same approach to the other relevant pages as well. |
|
Thanks for the update, this looks like the right direction
The contextual documentation link on the project configuration page makes
sense and feels more intuitive than the global help icon.
Yes, please go ahead and apply the same approach to the other relevant
pages as well.
…On Thu, 26 Feb 2026 at 23:26, Sahitya Singh ***@***.***> wrote:
*Sahitya0805* left a comment (openSUSE/open-build-service#19279)
<#19279 (comment)>
Thanks for the feedback! I’ve updated the PR and replaced the global help
icon with a contextual documentation link on the project configuration page.
Let me know if this feels like the right direction, and I can apply the
same approach to the other pages as well.
—
Reply to this email directly, view it on GitHub
<#19279 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BTY5OI7MG4L6QBDBPOGGQ5T4N4XWDAVCNFSM6AAAAACVDQHGFCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTSNRYGI2DIMBXGA>
.
You are receiving this because you commented.Message ID:
***@***.***>
|

Hey friends!
I’ve extended the contextual documentation approach to a few key configuration-related pages to demonstrate the pattern clearly. This ensures that users have immediate access to relevant help documentation directly from the most critical project settings screens.
Pages updated in this PR:
Project Configuration: Verified and aligned with the existing pattern.
Build Configuration: Added a "Documentation ↗" link near the page title.
Label Templates: Added a "Documentation ↗" link near the page title.
This change improves consistency across the configuration interface and helps users navigate complex settings with direct links to the OBS User Guide. If this direction looks good, I can continue applying the same approach to other relevant pages.
Here is a screenshot of how it looks: