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

Migrate main navigation #4

Closed
bencodezen opened this issue Dec 19, 2019 · 3 comments · Fixed by #206
Closed

Migrate main navigation #4

bencodezen opened this issue Dec 19, 2019 · 3 comments · Fixed by #206
Assignees
Labels
content Issues / PRs related to docs content
Milestone

Comments

@bencodezen
Copy link
Member

bencodezen commented Dec 19, 2019

Description updated to reflect a decision we've come up on comments

  • Docs
    • Guide
    • Examples
    • Style Guide
    • Cookbook
  • API Reference
  • Ecosystem
    • Official Projects
      • There could be a page to brief core libs/tools like: vuex, vue-router, vue-test-utils, vue-cli, vue-devtools, eslint-plugin-vue, etc. one-by-one. At the same time of course provide the link to each of the respective project. At very last, provide a link to our GitHub org to guide people explore more projects made by us.
    • Community
      • Another page maybe to brief how to get help, news, roadmap, events, social media accounts, jobs, partners, awesome projects and themes, by listing all useful links in categories.
  • Support Vue
  • Translations
@bencodezen bencodezen added this to the alpha milestone Jan 8, 2020
@bencodezen bencodezen added the content Issues / PRs related to docs content label Jan 8, 2020
@NataliaTepluhina
Copy link
Member

Proposed structure (currently implemented on Vuepress):

  • Docs
    • Guide
    • Style Guide
    • Tooling (core libraries + tooling, could be renamed to Ecosystem maybe?)
  • API Reference
  • Examples
    • Examples (should find better name for current examples maybe)
    • Cookbook
  • Community - this should lead to a separate document where Help + News + Resource Lists are shown on the sidebar for easier navigation

@Jinjiang
Copy link
Member

Jinjiang commented Apr 22, 2020

I think there are 2 types of links: internal links and external links.

For our main navigation, it's better to expand internal links more and fold up external links a little bit relatively, because we could assume users come here more like find out something inside I guess.

So my idea is:

  • Docs (priority: 1)
    • Guide
    • Examples
    • Style Guide
    • Cookbook
  • API Reference (priority: 2)
  • Ecosystem (priority: 5)
    • Official Projects
      There could be a page to brief core libs/tools like: vuex, vue-router, vue-test-utils, vue-cli, vue-devtools, eslint-plugin-vue, etc. one-by-one. At the same time of course provide the link to each of the respective project. At very last, provide a link to our GitHub org to guide people explore more projects made by us.
    • Community
      Another page maybe to brief how to get help, news, roadmap, events, social media accounts, jobs, partners, awesome projects and themes, by listing all useful links in categories.
  • Support Vue (priority: 3)
    I think this should be here as the first level because we definitely need this IMO.
  • Translations (priority: 4)
  • GitHub (priority: 100)

If the main navigation is too limited to contain all of these, then we could put the GitHub, Ecosystem, even Translations in some other ways or somewhere else.

Thanks.

@NataliaTepluhina
Copy link
Member

NataliaTepluhina commented May 3, 2020

@Jinjiang I like this proposal!

We could put GitHub links to docs repo in the footer of every single page (via Edit this page on GitHub link) and we have GH link to core repo on the homepage.

Rest are 5 links in navbar and I believe we can survive this amount 😅

@NataliaTepluhina NataliaTepluhina self-assigned this Jul 17, 2020
@NataliaTepluhina NataliaTepluhina linked a pull request Jul 17, 2020 that will close this issue
TalexDreamSoul pushed a commit to Talexs/docs that referenced this issue Apr 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Issues / PRs related to docs content
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants