Comments (3)
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.
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.
- Official Projects
- 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.
@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)
- Official website documentation-ecosystem-ui component BUG HOT 2
- Docs: Code blocks writing standards HOT 2
- the search function of the online page is not worked HOT 3
- 搜索功能点了没反应 HOT 2
- Add VNode type as the first argument of `h` HOT 1
- v-model parameters are different in Playground and web,makes it difficult to understand HOT 2
- Website home page nav bar looks weird on Firefox HOT 5
- Docs: unobvious warning in custom-directives HOT 4
- Add documentation for "VNode Lifecycle Events" HOT 2
- Slot -> Scoped Slots ->Fancy List Example:All values use item, and it looks like name="item" could be replaced with name="list-item" (or something better) to distinguish between variables and strings. HOT 1
- Header `\*` markers showing up in render HOT 3
- 便宜机场推荐 :2024 最新好用便宜机场推荐
- Transitions API link opens 404 in vue router v3 docs
- There is an error in 'Creating a Vue Application' using the yarn command line in QuickStart
- ref回调错误
- vue中文版文档刷新页面有js报错 HOT 1
- Add a note or caution to the documentation for the `customRef` function. HOT 2
- Class and Style Bindings HOT 1
- Create project with yarn HOT 2
- Update `yarn create` command HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs.