pytorch / pytorch/pytorch.github.io
Contributing guide missing
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 285
- Forks
- 317
- PR merge metrics
- No merged PRs in 30d
Description
Neither template fitted this issue:
I came to this repository in the hope of updating the documentation for a particular module's function.
I can't see a contributing guide in this repository for updating the documentation served from pytorch.org.
It took me quite a while to realise that the .html files in this repo seem to be generated from the docstrings in the pytorch repo.
How about a contributing.md pointing to the pytorch repo for code documention updates?
Also, perhaps document the structure of this repository Eg:
docs/masteris the next releasedocs/releaseis the current release
It seems that make serve serves from release. How to serve from master?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting docs/master, docs/release, the existing make serve entry point, and how the site is generated from PyTorch docstrings. Done means a contributing.md explains where documentation updates belong, documents the repository structure and release directories, and answers how to serve master instead of release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100