Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc Navigation Naming #1276

Closed
jrleeman opened this issue Jan 9, 2020 · 1 comment · Fixed by #1294
Closed

Doc Navigation Naming #1276

jrleeman opened this issue Jan 9, 2020 · 1 comment · Fixed by #1294
Labels
Area: Docs Affects documentation Type: Bug Something is not working like it should
Milestone

Comments

@jrleeman
Copy link
Contributor

jrleeman commented Jan 9, 2020

Naming is hard, but here's some feedback on the homepage of the MetPy docs:

  • Reference/API examples seems long and as soon as I see API I'm clicking to get the the API docs, not examples. I think I'd just call it examples.
  • Topical examples takes you to the gallery, which I wasn't prepared for. A new window at minimum, but ideally some way to indicate this is not a MetPy docs page. Also I read it "tropical" every time given the context.
  • The reference guide lost the API part of its name. See the first comment, but I'd advocate for it coming back.
@jrleeman jrleeman added the Type: Bug Something is not working like it should label Jan 9, 2020
@dopplershift
Copy link
Member

The reference guide lost the API part of its name. See the first comment, but I'd advocate for it coming back.

coughs You should look at PR #920 😉

The problem we were solving was a user who had no idea that we had all the functions documented on the site, and "The MetPy API" didn't communicate this to them. I still like reference guide. Maybe just "Reference Examples"? "Basic Examples"?

@dopplershift dopplershift added the Area: Docs Affects documentation label Jan 9, 2020
@dopplershift dopplershift added this to the 1.0 milestone Jan 9, 2020
dopplershift added a commit to dopplershift/MetPy that referenced this issue Jan 12, 2020
Change to "Examples" and "Python Gallery (separate site)". Also updated
link to gallery.
@dopplershift dopplershift mentioned this issue Jan 12, 2020
5 tasks
dopplershift added a commit to dopplershift/MetPy that referenced this issue Jan 12, 2020
Change to "Examples" and "Python Gallery (separate site)". Also updated
link to gallery.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Docs Affects documentation Type: Bug Something is not working like it should
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants