-
Notifications
You must be signed in to change notification settings - Fork 4.7k
feature request rework user navigation to be more clearer #1839
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
Conversation
link: "/config/index.html" | ||
}, | ||
{ | ||
text: "Api", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we be specific here that it is the CLI API?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not really actually i didnt do a lot of stuff i wanted first to present the idea behind
@f3ltron I think this is a great start. Thanks for doing this! I think all we need is for you to make the PR semantic and I'm happy to approve so we can merge this! |
maybe i should implement the plugin and theme list before too @bencodezen ? We just have to choose what we design we want tell me wich one your prefer: |
@f3ltron I think the NativeScript one is a good start. Also, if it's going to take a few days to get that done (i.e., themes and plugins list), I'm thinking we can split that out to a separate issue? The other information is good and is worth exposing to the public sooner rather than later. |
I was thinking about doing a simple listing first and next reproduce nativescript design |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should use '
in the whole of the project.
Ok i will change that dont know why my vscode is not using the linter |
Cool, It would be better if we could follow these principles:
|
@ulivz @bencodezen i have a quesiton about plugins / theme validation do we have some requirement to valid theme entering into community plugin ? I was thinking about :
Have no idea about theme : @jlooper maybe you have ideas ? It could help me a lot |
Ok i will need some help on default theme templates and with translations |
@f3ltron I think your suggestions around official themes / plugins requiring a certain level of docs and tests is a great idea. Let's build on that in Notion so we have a template that everyone can follow when we publish it on the site. |
Block for now. Waiting for on #1847 |
@f3ltron I was approving the .vscode removal from .gitignore. 😅 Whoops. Definitely wait for @ulivz' approval before doing anything. I am still getting acclimated to the source code. Also, it looks like we have some merge conflicts. |
yeah i think it's relative to the last merge i will resolve them. There is not real breaking change here just navigation rework and addition |
Some conflicts here. 😅 |
IMO at least the Config should be placed behind Guide at the same level, which is the convention of all Vue.js projects. // cc @yyx990803 |
We wanted to introduce something more like nuxt doc. Like a getting started that will redirect to the config reference in some points. The idea was to point the plugins library first and the getting started. People want to use vuepress fast and know about libs (plugin / theme) I am not sure if i explain it well |
Summary
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx]
, where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.
Other information:
I was thinking about re organize user navigation stuff.
Why ?
Actually when i want to find some informations about vuepress i feel like a bit lost.
What i propose ?
You can clone and checkout the branch and will have example on en.
In Learn more you will now have:
Why ?
I wanted to regroup informations do not split them.
You will now have one nav for plugins and theme => Plugins / Theme | OR | Market Place as a proposal.
As we plan to have some listing about themes and plugins community
I thought about doing some sort listing like:
By doing this i splited the creation part of them into the menu before Learn more.
It will be more explicit with an img 👍