Skip to content

Commit 0830396

Browse files
committed
Improve Report Issue UX per issue #43
- Changed cryptic target icon to speech bubble (chat/comment icon) - Open issue page in new tab so users can still see the documentation - Merged documentation contribution text into Getting Help section - Added emoji hint (💬) to help users identify the icon Fixes #43 Underworld development team with AI support from Claude Code
1 parent 0077def commit 0830396

File tree

3 files changed

+3
-9
lines changed

3 files changed

+3
-9
lines changed

docs/_static/report-issue.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,6 @@ document.addEventListener('DOMContentLoaded', function() {
2323
});
2424

2525
reportLink.href = baseUrl + '?' + params.toString();
26+
reportLink.target = '_blank'; // Open in new tab so user can still see the page
2627
}
2728
});

docs/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,7 @@
135135
"url": "https://github.com/underworldcode/underworld3/issues/new?labels=documentation&template=docs-issue.md",
136136
"html": """
137137
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
138-
<path d="M8 9.5a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Z"></path>
139-
<path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Z"></path>
138+
<path d="M0 2a2 2 0 0 1 2-2h12a2 2 0 0 1 2 2v8a2 2 0 0 1-2 2H4.414a1 1 0 0 0-.707.293L.854 15.146A.5.5 0 0 1 0 14.793V2zm3.5 1a.5.5 0 0 0 0 1h9a.5.5 0 0 0 0-1h-9zm0 2.5a.5.5 0 0 0 0 1h9a.5.5 0 0 0 0-1h-9zm0 2.5a.5.5 0 0 0 0 1h5a.5.5 0 0 0 0-1h-5z"></path>
140139
</svg>
141140
""",
142141
"class": "",

docs/index.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -156,13 +156,7 @@ Underworld3 is a Python library for computational geodynamics, built on:
156156
- Join community discussions
157157
- [Underworld Blog](https://www.underworldcode.org)
158158

159-
### Improving the Documentation
160-
161-
Found a typo, broken link, or have a suggestion? We welcome contributions to improve the documentation.
162-
163-
**Report an issue**: Click the "Report Issue" icon in the page footer. This opens a GitHub issue pre-filled with the current page URL and title.
164-
165-
**Edit directly**: Click the "Edit on GitHub" button (top right of any page) to propose changes directly via a pull request.
159+
**Found a typo or broken link?** Click the speech bubble icon (💬) in the page footer to report it—the issue will be pre-filled with this page's URL. You can also click the GitHub icon to browse the repository, or use "Edit on GitHub" (top right) to propose changes directly.
166160

167161
### Try It Now
168162

0 commit comments

Comments
 (0)