numpy / numpy/numpy.org

Reduce categories in the top menu bar

Open
#234 17 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content
Dominant language
Shell
Stars
128
Forks
132
Avg merge
1d 18h
Merged PRs (30d)
3

Description

Some subjects in the menu bar might be hard for an outsider to tell apart. Then the menu bar fails to serve its purpose -- getting people where they want to go swiftly.

  1. Install
  2. Documentation
  3. Learn
  4. Array computing
  5. Community
  6. About Us
  7. Contribute

We shouldn't force the reader to guess how we're distinguishing "Learn" from "Documentation." We should present one choice, "Documentation", and the landing page will let the reader choose one of the Procida paths: Tutorials, How-To Guides, Explanation, and Reference.

"Array computing" tells the reader hardly anything about what to expect. No one would have a reason other than curiosity to click it. I think I understand -- the subject is fundamental and overarching, so we've given it a place of its own. But it's documentation. Its readership will draw from exactly the subset of people who are reading documentation. To honor its significance we can give it prominence on the documentation page.

"Community," "About Us," and "Contribute" sound too similar. The reader wonders what the difference is between the first two, and sites often seem to put Contribute on a Community page. I can see the value of making a special spot for contributors, and "about" is a web word people know to look for, so we can reduce this to "About us" and "Contribute."

Contributor guide

Open the contributing guide

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 at the website's top menu bar and review how the current categories distinguish Documentation, Learn, Array computing, Community, About Us, and Contribute. Compare the existing navigation with the proposed consolidated choices and verify that visitors can still reach each destination. Done means the menu presents the agreed, unambiguous categories and the documentation landing page exposes the relevant paths.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.