Skip to content

Commit 8a429b7

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 5749f57 commit 8a429b7

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/development/docsguide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
# Documentation Notes
22

33
## Vision
4+
45
We believe a clear documentation is important to community building, reproducibility, and transparency in our open-source project. To make it easier to write our documentation in a consistent way, here we outline a brief vision for our documentation based heavily on a few common resources.
56

67
```{note}
78
TODO: outline functions of the documentation based on resources
89
```
10+
911
### Resources
12+
1013
- [Divio Documentation System](https://docs.divio.com/documentation-system/)
1114
- [PyOpenSci Documentation Guide](https://www.pyopensci.org/python-package-guide/documentation/index.html#)
1215
- [Write the Docs Guide](https://www.writethedocs.org/guide/)
1316
- [NumPy Documentation Article](https://labs.quansight.org/blog/2020/03/documentation-as-a-way-to-build-community)
1417

1518
## Style guide
16-
- Write documentation in first person plural ("we"). In our open source code, tutorials and guides can be written by any developer or user, so the documentation teaches all of us how to do something with Parcels.
19+
20+
- Write documentation in first person plural ("we"). In our open source code, tutorials and guides can be written by any developer or user, so the documentation teaches all of us how to do something with Parcels.

0 commit comments

Comments
 (0)