frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated Where or how should I add documentation? (markdown)

Richard Zou
2021-08-13 09:31:27 -04:00
parent 441e832874
commit 0a25d4db7c
1 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
Where-or-how-should-I-add-documentation?.md

@ -4,13 +4,30 @@
The [PyTorch Developer Wiki](https://github.com/pytorch/pytorch/wiki/) is the home for developer-facing PyTorch documentation. User-facing documentation goes on [pytorch.org/docs](https://pytorch.org/docs/stable/index.html).
Documentation can easily go out of date. This page is meant to be a guide to best practices for adding new pages, editing a page, or suggesting edits to a page to help keep the documents up-to-date.
Documentation can easily go out of date. This page is meant to be a guide to best practices for where to add pages, how to add pages, editing a page, or suggesting edits to a page to help keep the documents up-to-date.
## Adding a new page
## Where should I put developer-facing docs?
Please add developer docs to the Developer Wiki! There are a number of places where developer documentation exists today:
- in README files of subdirectories in pytorch/pytorch
- in CONTRIBUTING.MD
Adding your docs to the Developer Wiki has the following benefits:
- It's easy to update the documentation -- no need to sit through a land cycle
- It's easier to find the information: READMEs are not very discoverable
- All the information is in one place for searching (and you can use GitHub search to search only the wiki!)
Our recommendation is to add a Wiki page and link to it with a quick blurb in some README file or CONTRIBUTING.MD.
## Adding a new page to the Developer Wiki
Each page should have a "Page Maintainers: " section at a very top that lists the GitHub handles of folks responsible for maintaining the page. *Maintainers* are responsible for keeping the pages up to date.
## A page looks out of date, what do I do?
* For small changes, feel free to fix it yourself.
* For larger changes, or if you're not sure how to correct something, open a GitHub issue and assign it to the maintainers.
* For larger changes, or if you're not sure how to correct something, open a GitHub issue and assign it to the maintainers.
## Where do I actually write user-facing docs?
See [CONTRIBUTING.MD](https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md#writing-documentation)