pytorch / pytorch/pytorch.github.io

Multiple dead links on `https://pytorch.org/serve/use_cases.html`.

Open
#1,764 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
285
Forks
317
PR merge metrics
No merged PRs in 30d

Description

📚 Documentation

Multiple links on the page https://pytorch.org/serve/use_cases.html return 404 error or link to the wrong place. This seems to be because the file https://github.com/pytorch/serve/blob/master/docs/use_cases.md links to markdown files outside of the docs folder inside the pytorch/serve repository. The links work fine on GitHub, however they don't work on the live website.

Inside the use_case.md file of the Serve repo, there are:

  • 8 links to the README.md file inside /docker
  • 13 links to the README.md file inside /examples
  • 1 link to README.md in root directory (this links to a section that does not exist)

I'm looking to start contributing to PyTorch, so would like to give this issue a go. I'm not sure how the docs on the https://pytorch.org/serve path are generated. But it seems like any .md files inside the /docs folder are available on the website. Solution could be to possibly move the files that are being linked into /docs directory.

I'm open to hearing any thoughts, and wether this is something that should be fixed.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/use_cases.md and inspect how links to /docker, /examples, and the repository README are transformed for https://pytorch.org/serve/use_cases.html. Check the documentation generation setup in this repository before deciding where the linked content belongs. Done means the listed links resolve on the live page and point to the intended content.

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
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.