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

Reorganize headings #930

Closed
hzoo opened this Issue Sep 30, 2016 · 9 comments

Comments

Projects
None yet
3 participants
@hzoo
Member

hzoo commented Sep 30, 2016

screen shot 2016-09-30 at 10 55 01 am

  • If we want to add a "syntax highlighting" guide/section where can it go?

Maybe we can move Learn ES2015 since it's on the page in a few other places

@mareksuscak

This comment has been minimized.

Show comment
Hide comment
@mareksuscak

mareksuscak Sep 30, 2016

Collaborator

IMO we could replace "Learn ES2015" with "Docs", "Guides" or "Recipes" or something similar. Possibly also moving some of the top level sections under that new entry.

Collaborator

mareksuscak commented Sep 30, 2016

IMO we could replace "Learn ES2015" with "Docs", "Guides" or "Recipes" or something similar. Possibly also moving some of the top level sections under that new entry.

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Sep 30, 2016

Member

Ok maybe make it Docs | Setup | Try it Out | FAQ?

Member

hzoo commented Sep 30, 2016

Ok maybe make it Docs | Setup | Try it Out | FAQ?

@mareksuscak

This comment has been minimized.

Show comment
Hide comment
@mareksuscak

mareksuscak Sep 30, 2016

Collaborator

@hzoo Yeah that would make a lot of sense. Where to put Learn ES2015, Plugins and Usage tho? The first two could become subsections of the Docs but Usage contains its own subsections. How to deal with that? 2nd level subsections?

Collaborator

mareksuscak commented Sep 30, 2016

@hzoo Yeah that would make a lot of sense. Where to put Learn ES2015, Plugins and Usage tho? The first two could become subsections of the Docs but Usage contains its own subsections. How to deal with that? 2nd level subsections?

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Sep 30, 2016

Member

We could just move everything in Usage under Docs and only have 1 subsection

Member

hzoo commented Sep 30, 2016

We could just move everything in Usage under Docs and only have 1 subsection

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Sep 30, 2016

Member

It hasn't been updated in a while so definetely can try some different stuff out

Member

hzoo commented Sep 30, 2016

It hasn't been updated in a while so definetely can try some different stuff out

@danharper

This comment has been minimized.

Show comment
Hide comment
@danharper

danharper Oct 26, 2016

Member

I think the docs need a sidebar, like the React docs.

How about this for a re-structured top nav:

Primary Nav (left):

* Docs
* Try it out
* Community
* Blog

Secondary Nav (right):

* Twitter
* GitHub

Then on the Docs page, the following sidebar:

# Quick Start

* Browser
* Node
* Plugins
* Polyfills
* Caveats (or.. Browser Support)
* Editors
* Linting
* Babili (Minification)

# Advanced Usage

* Options
* CLI
* babel-node
* In-Browser Compilation
* Babel API

I'm unsure where a "Learn ESXXX" would go, but wherever it goes perhaps just give "highlights" and link off-site for the details. Plenty of community resources for that.

Member

danharper commented Oct 26, 2016

I think the docs need a sidebar, like the React docs.

How about this for a re-structured top nav:

Primary Nav (left):

* Docs
* Try it out
* Community
* Blog

Secondary Nav (right):

* Twitter
* GitHub

Then on the Docs page, the following sidebar:

# Quick Start

* Browser
* Node
* Plugins
* Polyfills
* Caveats (or.. Browser Support)
* Editors
* Linting
* Babili (Minification)

# Advanced Usage

* Options
* CLI
* babel-node
* In-Browser Compilation
* Babel API

I'm unsure where a "Learn ESXXX" would go, but wherever it goes perhaps just give "highlights" and link off-site for the details. Plenty of community resources for that.

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Oct 26, 2016

Member

So the docs used to have a sidebar for headings (per page) but there was some bug when moving from redcarpet to kramdown that i didn't figure out

Yeah having more pages and more split apart rather than all in plugins would be great

Member

hzoo commented Oct 26, 2016

So the docs used to have a sidebar for headings (per page) but there was some bug when moving from redcarpet to kramdown that i didn't figure out

Yeah having more pages and more split apart rather than all in plugins would be great

@mareksuscak

This comment has been minimized.

Show comment
Hide comment
@mareksuscak

mareksuscak Nov 24, 2016

Collaborator

You mean this sidebar?

screen shot 2016-11-24 at 15 27 36

Has it been fixed recently or you meant another one? I'd love to help move this guy forward so what's the final decision? Do we want to add yet another sidebar on the left or just keep it as simple as it is now and have one huge page containing all the sections?

Collaborator

mareksuscak commented Nov 24, 2016

You mean this sidebar?

screen shot 2016-11-24 at 15 27 36

Has it been fixed recently or you meant another one? I'd love to help move this guy forward so what's the final decision? Do we want to add yet another sidebar on the left or just keep it as simple as it is now and have one huge page containing all the sections?

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Nov 24, 2016

Member

Yeah the sidebar you have there is the one that got fixed (the script was loading).

I was meaning the header at the top - we should simplify that somehow

screen shot 2016-11-24 at 9 34 50 am

screen shot 2016-11-24 at 9 35 06 am

screen shot 2016-11-24 at 9 35 36 am

Maybe just Docs | Setup | Try it Out on the left, or even just Docs | Try It Out and then create a docs page that links to everything else.

And yes we should split up the plugins page since that is huge (one easy change is a page that explains what plugins are (the info) vs the list of actual plugins)

Member

hzoo commented Nov 24, 2016

Yeah the sidebar you have there is the one that got fixed (the script was loading).

I was meaning the header at the top - we should simplify that somehow

screen shot 2016-11-24 at 9 34 50 am

screen shot 2016-11-24 at 9 35 06 am

screen shot 2016-11-24 at 9 35 36 am

Maybe just Docs | Setup | Try it Out on the left, or even just Docs | Try It Out and then create a docs page that links to everything else.

And yes we should split up the plugins page since that is huge (one easy change is a page that explains what plugins are (the info) vs the list of actual plugins)

@hzoo hzoo closed this in #1041 Dec 6, 2016

@hzoo hzoo referenced this issue Dec 6, 2016

Closed

Docs Sidebar #1042

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment