Conversation
louismaximepiton
added
🗳️ feature
📖 documentation
github-project-automation
bot
moved this to In Progress / Draft
in 🟣 [Orange-Boosted-Bootstrap] PRs Board
✅ Deploy Preview for boosted ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
I do not have a strong opinion but while I think "report a bug" and "ask a question" should be easily findable and on every pages, I'm not sure this is the right position for them. |
|
TBH, I was thinking of floating buttons or something like that, but it can cause much a11y issues, do you have anything in mind ? |
boosted-bot
moved this from In Progress / Draft
to Need Dev Review
in 🟣 [Orange-Boosted-Bootstrap] PRs Board
There was a problem hiding this comment.
Pull request overview
This PR adds quick-access buttons ("easing links") at the top of documentation pages to facilitate user contributions through GitHub issues and discussions. The implementation includes new SVG icons, URL-based GitHub integrations, and a corresponding issue template.
Changes:
- Added bug and message-talk SVG icons to sprite files across three theme variants
- Added three action buttons to DocsLayout.astro header: View on GitHub, Report a bug, and Ask a question
- Created new user-agent.js script to append browser information to issue URLs
- Added doc_report.yml issue template for documentation-specific bug reports
Reviewed changes
Copilot reviewed 4 out of 7 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| site/static/sosh/docs/[version]/assets/img/ouds-web-sprite.svg | Added bug and message-talk icons with 24x24 viewBox |
| site/static/orange/docs/[version]/assets/img/ouds-web-sprite.svg | Added bug and message-talk icons with 960x960 viewBox |
| site/static/orange-compact/docs/[version]/assets/img/ouds-web-sprite.svg | Added bug and message-talk icons with 960x960 viewBox |
| site/src/layouts/DocsLayout.astro | Modified header to include three action buttons with icons and GitHub links |
| site/src/assets/partials/user-agent.js | Created script to append user-agent string to GitHub issue URLs |
| site/src/assets/application.js | Added import and call for user-agent script |
| .github/ISSUE_TEMPLATE/doc_report.yml | Created new issue template for documentation bug reports |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // OUDS mod: Add userAgent on GitHub issues link | ||
| export default () => { | ||
| document.querySelectorAll('.add-user-agent').forEach(element => { | ||
| element.href += `&user-agent=${window.navigator.userAgent}` |
There was a problem hiding this comment.
Don't we need to encodeURIComponent to be sure that we don't get any problem with special characters ?
Co-authored-by: Vincent Prothais <vincent.prothais@orange.com>
Co-authored-by: Vincent Prothais <vincent.prothais@orange.com>
boosted-bot
moved this from Need Dev Review
to Dev Review In Progress
in 🟣 [Orange-Boosted-Bootstrap] PRs Board
github-project-automation
bot
moved this from Dev Review In Progress
to Done
in 🟣 [Orange-Boosted-Bootstrap] PRs Board
3 participants
Related issues
Closes #3363
Description
Proposal to add easing links at the top of every page for people willing to help:
Also add an easy to fill issue template.
Questions
If we plan to merge it, maybe better the a11y of these buttons, better the icons, add discussion templates
Checklists
Progression (for Core Team only)
ouds/mainfollowing conventional commitLive previews