Repository navigation
Move <Service> Overview sections into only the top level #549
Description
Activity
- addedtype: questionRequest for information or clarification. Not an issue.Request for information or clarification. Not an issue.
on May 8, 2015 I believe the reason for this is that they don't have to go to the overview page to get a general idea of what the API does. I think @stephenplusplus can speak more to this.
I'm down with this. Trying to be too helpful can sometimes be less helpful.
Seems to me that it's also taking up some pretty valuable screen real-estate...
Do you guys have any ideas on how we could document the Getting Started (expandable thing) and the Overview in a way that:
- doesnt take up tons of screen real estate
- still is visible on all the pages
?
I think limiting to the top level page will help. It just makes sense that if someone is in the Datastore -> Transaction docs, they would think to go up a level to Datastore to learn more about Datastore.
Doing this could even let us get rid of the "Overview" section, and just move its content to the JSdoc blocks for the modules.
Using BigQuery's page as an example, it would look like:
👍
Yeah I agree, for a page like http://googlecloudplatform.github.io/gcloud-node/#/docs/master/datastore/dataset?method=save we don't really need all the overview. Distracts from the method-specific docs.
- added 2 commits that reference this issue
on May 9, 2015 - added and removedtype: questionRequest for information or clarification. Not an issue.Request for information or clarification. Not an issue.
on May 9, 2015 - changed the title
[-]Move <Service> Overview sections into only the top level?[/-][+]Move <Service> Overview sections into only the top level[/+]on May 9, 2015 20 remaining items
- added a commit that references this issue
on Jan 21, 2026 - added a commit that references this issue
on Jan 28, 2026 - added 2 commits that reference this issue
on Feb 4, 2026 - added a commit that references this issue
on Feb 24, 2026 - added a commit that references this issue
on Feb 25, 2026 - added a commit that references this issue
on Feb 26, 2026 - added a commit that references this issue
on Mar 5, 2026 - added a commit that references this issue
on Mar 17, 2026 - added 2 commits that reference this issue
on Mar 23, 2026 - added a commit that references this issue
on Mar 27, 2026 - added a commit that references this issue
on May 5, 2026

Right now, the Overview sections appear on every page for the classes under that service:
Do you think it would make more sense to move these sections into the top levels only?
Thoughts?