Giter VIP home page Giter VIP logo

Comments (3)

NataliaTepluhina avatar NataliaTepluhina commented on May 7, 2024

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

from docs.

Jinjiang avatar Jinjiang commented on May 7, 2024

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.

from docs.

NataliaTepluhina avatar NataliaTepluhina commented on May 7, 2024

@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 😅

from docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.