pytorch / pytorch/pytorch.github.io

Website layout suggestion regarding the navigation bar

Open
#17 3 comments 1 reaction 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

I have two little suggestions with regard to improving the PyTorch website

  1. It may be a good idea to include a link to the Tutorials in the navigation pane and rename the "Docs" to "API Docs" or so. This would make it easier for new users to find it. And for returning users, it would be easier than scrolling through the main page.

Alternatively, the "Docs" button could be a nested button with "API, Tutorials, API" under it that open up upon hovering over it (like, e.g., in the Mkdocs templates)

  1. It would maybe a nice thing to include a link to the "http://pytorch.org" main page on the http://pytorch.org/docs/ page. Sometimes, I am browsing the API docs and want to navigate back to the main page to get to & search the forum.

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 by inspecting the website navigation and the API documentation page mentioned in the issue, then identify where their links and labels are defined. The work is done when Tutorials is discoverable from navigation, Docs is clearly labeled or nested as proposed, and the documentation page links back to the main site.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.