Skip to content

docs: add usage to config reference #2211

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

brunetton
Copy link
Contributor

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:

Copy link
Collaborator

@billyyyyy3320 billyyyyy3320 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's configuration section in guide already, and it's precise enough IMO.

@brunetton
Copy link
Contributor Author

brunetton commented Mar 21, 2020

You HO is the opinion of a developer of the project, using it for years probably. In your position, everything is obvious.
If I took time to make this PR, it's because for a new user (2 on this case), this is far from being obvious. IMHO newcomers remarks are super precious when I start a project (except for personal project that I absolutely don't document at all).
Maybe you want all new users to use another project, more documented, and this project to be forgot by the community ?
In our company, we stopped trying to use VuePress and swapped to another technology already. But we wanted to take time to help you identify when new users loose time.

So, if you don't want to repeat yourself in doc (which is a good thing), why don't you add a link to the doc section you pointed out with something like "for more details it's here"? Does it prevents advanced users from read the doc anyway? I doubt advanced users read this section of the doc so this is clearly for newcomers.

@billyyyyy3320
Copy link
Collaborator

billyyyyy3320 commented Mar 21, 2020

@brunetton That's why I left it open so that I can get your feedback which I didn't see in this PR. I assumed that new users should have read the guide section first. Apologies if my words offended you.

Agreed with your point about adding a reference link.

Here's my suggestion:

  1. Maybe using a code block to demonstrate will be more precise, such as:
module.exports = {
  // ...config
}
  1. Add it before Basic Config since not only basic config are going to be place in .vuepress/config.js

@billyyyyy3320 billyyyyy3320 changed the title Update README.md docs: add usage to config reference Mar 21, 2020
@brunetton
Copy link
Contributor Author

No offense here, don't worry! Just arguing because I had some time.
Yes a little code block or a reference is perfect (or both). I don't think this need to spend time to choose the perfect form, the important thing is that information is there (IMHO, of course).
Thank for replying, have a nice day

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants