-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
42 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
name: Suggest Documentation change | ||
about: 'Suggest a documentation change' | ||
title: '' | ||
labels: 'doc-edit' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- A short summary of the proposed documentation change --> | ||
|
||
|
||
#### Section to be changed | ||
|
||
#### Expected Output | ||
|
||
|
||
#### Problem Description | ||
<!-- this should explain why the current behavior is a problem and why the expected output is a better solution --> | ||
|
||
|
||
#### Versions | ||
|
||
<details><summary>Output of `argopy.show_versions()`</summary> | ||
|
||
<!-- Paste the output here argopy.show_versions() here --> | ||
|
||
|
||
</details> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
(section-4)= | ||
# Contributing to the documentation | ||
|
||
## 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. | ||
|
||
|
||
This should take users to the documentation hosting repository where one of the templates can used: | ||
- "Suggest Documentation change", | ||
- "Report an error on the documentation" |