Skip to content

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

Closed
wants to merge 8 commits into from

Conversation

flozero
Copy link
Collaborator

@flozero flozero commented Sep 6, 2019

Summary

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

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:

  • Config reference
  • Api
  • Create a plugin
  • Create a theme
  • Contribution Guide
  • miscellaneous

Why ?

I wanted to regroup informations do not split them.

  1. You will now have one nav for plugins and theme => Plugins / Theme | OR | Market Place as a proposal.

  2. 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 👍

Screen Shot 2019-09-05 at 11 26 47 PM

@flozero flozero self-assigned this Sep 6, 2019
@flozero flozero added contribution welcome Contributions welcome topic: docs Used when working with docs type: enhancement Request to enhance an existing feature type: feature request Request to add a new feature type: question or discussion Question or discussion labels Sep 6, 2019
@flozero flozero changed the title chore(navigation): rework user navigation to be more clearer feature request rework user navigation to be more clearer Sep 6, 2019
link: "/config/index.html"
},
{
text: "Api",
Copy link
Member

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?

Copy link
Collaborator Author

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

@bencodezen
Copy link
Member

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

@flozero
Copy link
Collaborator Author

flozero commented Sep 7, 2019

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:

@bencodezen
Copy link
Member

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

@flozero
Copy link
Collaborator Author

flozero commented Sep 8, 2019

I was thinking about doing a simple listing first and next reproduce nativescript design

Copy link
Member

@ulivz ulivz left a 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.

@flozero
Copy link
Collaborator Author

flozero commented Sep 9, 2019

Ok i will change that dont know why my vscode is not using the linter

@ulivz
Copy link
Member

ulivz commented Sep 9, 2019

Cool, It would be better if we could follow these principles:

  1. Avoid unnecessary formatted changes, so we can review the changes and track the history easily.
  2. Follow the historical convention, if it needs to be changed, we can open new topics to discuss it.

@flozero
Copy link
Collaborator Author

flozero commented Sep 9, 2019

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

  • valid docs that explain the plugin (require)
  • unit test that will validate important functions ? (optional / require)
  • the plugin must come with something usefull (require)
  • comes with a PR

Have no idea about theme : @jlooper maybe you have ideas ? It could help me a lot

@flozero flozero added the help wanted Extra attention is needed label Sep 9, 2019
@flozero
Copy link
Collaborator Author

flozero commented Sep 9, 2019

Ok i will need some help on default theme templates and with translations

@bencodezen
Copy link
Member

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

@flozero
Copy link
Collaborator Author

flozero commented Sep 12, 2019

Block for now. Waiting for on #1847

@bencodezen
Copy link
Member

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

@flozero
Copy link
Collaborator Author

flozero commented Sep 13, 2019

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

@ulivz
Copy link
Member

ulivz commented Sep 23, 2019

Some conflicts here. 😅

@ulivz
Copy link
Member

ulivz commented Sep 23, 2019

IMO at least the Config should be placed behind Guide at the same level, which is the convention of all Vue.js projects.

image

// cc @yyx990803

@flozero
Copy link
Collaborator Author

flozero commented Sep 23, 2019

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

@meteorlxy meteorlxy closed this Jun 11, 2021
@meteorlxy meteorlxy deleted the feat/rework-navigation-proposal branch June 11, 2021 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution welcome Contributions welcome help wanted Extra attention is needed topic: docs Used when working with docs type: enhancement Request to enhance an existing feature type: feature request Request to add a new feature type: question or discussion Question or discussion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants