Add section to CONTRIBUTING.md explaining developer docs (#63228)
authorRichard Zou <zou3519@gmail.com>
Mon, 16 Aug 2021 22:35:05 +0000 (15:35 -0700)
committerFacebook GitHub Bot <facebook-github-bot@users.noreply.github.com>
Mon, 16 Aug 2021 22:44:10 +0000 (15:44 -0700)
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/63228

It is a quick summary and links to a page on the Developer Wiki that has
more detail.

Test Plan: Imported from OSS

Reviewed By: SplitInfinity

Differential Revision: D30347109

Pulled By: zou3519

fbshipit-source-id: a6242986d275e5279ca3f61ade2294a132d268c4

CONTRIBUTING.md

index d918e3f..66dbec2 100644 (file)
@@ -464,6 +464,17 @@ of very low signal to reviewers.
 
 ## Writing documentation
 
+So you want to write some documentation and don't know where to start?
+PyTorch has two main types of documentation:
+- user-facing documentation.
+These are the docs that you see over at [our docs website](pytorch.org/docs).
+- developer facing documentation.
+Developer facing documentation is spread around our READMEs in our codebase and in
+the [PyTorch Developer Wiki](pytorch.org/wiki).
+If you're interested in adding new developer docs, please read this [page on the wiki](https://github.com/pytorch/pytorch/wiki/Where-or-how-should-I-add-documentation%3F) on our best practices for where to put it.
+
+The rest of this section is about user-facing documentation.
+
 PyTorch uses [Google style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
 for formatting docstrings. Length of line inside docstrings block must be limited to 80 characters to
 fit into Jupyter documentation popups.