Skip to content

Commit 0077def

Browse files
committed
Add documentation contribution guidance to opening page
Added "Improving the Documentation" section explaining: - How to use the Report Issue footer icon (pre-filled with page URL/title) - How to use Edit on GitHub button for direct edits Underworld development team with AI support from Claude Code
1 parent 79a4d17 commit 0077def

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/index.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,11 +151,19 @@ Underworld3 is a Python library for computational geodynamics, built on:
151151

152152
### Getting Help
153153

154-
- [Report issues on GitHub](https://github.com/underworldcode/underworld3/issues)
155154
- [Browse API documentation](api/index.md)
155+
- [Report issues on GitHub](https://github.com/underworldcode/underworld3/issues)
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.
166+
159167
### Try It Now
160168

161169
Launch interactive tutorials directly in your browser:

0 commit comments

Comments
 (0)