diff --git a/.github/ISSUE_TEMPLATE/doc_edit_template.md b/.github/ISSUE_TEMPLATE/doc_edit_template.md index 5e4668e..a6a96e8 100644 --- a/.github/ISSUE_TEMPLATE/doc_edit_template.md +++ b/.github/ISSUE_TEMPLATE/doc_edit_template.md @@ -7,23 +7,8 @@ assignees: '' --- - + +#### Section to be modified -#### Section to be changed - -#### Expected Output - - -#### Problem Description - - - -#### Versions - -
Output of `argopy.show_versions()` - - - - -
+ diff --git a/images/screenshot_contributing.png b/images/screenshot_contributing.png new file mode 100644 index 0000000..1b176cc Binary files /dev/null and b/images/screenshot_contributing.png differ diff --git a/sections/section_contributing.md b/sections/section_contributing.md index eaf1b39..47ade54 100644 --- a/sections/section_contributing.md +++ b/sections/section_contributing.md @@ -3,9 +3,14 @@ ## Suggest modification -The easiest method to suggest modifications to the documentation maintainers is to click the "Open issues" button at the top of the page to be modified. +The easiest method to suggest modifications to the documentation maintainers is to click the "Open issue" button at the top of the page to be modified: +:::{figure-md} contributing + -This should take users to the documentation hosting repository where one of the templates can used: -- "Suggest Documentation change", +Click the Github>"Open Issue" icons to suggest a modification to a given page +::: + +This should take users to the documentation hosting repository where one of the following templates can used: +- "Suggest Documentation change" - "Report an error on the documentation"