Skip to content
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

Prepare 15.0.0 docs #6573

Merged
merged 21 commits into from Jan 25, 2023
Merged

Prepare 15.0.0 docs #6573

merged 21 commits into from Jan 25, 2023

Conversation

jeddy3
Copy link
Member

@jeddy3 jeddy3 commented Jan 10, 2023

Which issue, if any, is this issue related to?

Closes #6409

Is there anything in the PR that needs further explanation?

We are introducing some significant changes in 15.0.0, mainly deprecating rules and removing the processor config property. Many people will likely read the migration guide looking to understand how Stylelint fits into their modern toolchain. It's a golden opportunity for us to address some misconceptions and let people know what Stylelint is capable of and the direction we're taking.

This pull request makes changes to communicate that:

  • linters and pretty-printers are complementary tools
  • it's best to extend our standard config
  • there are many useful rules not turned on in the standard config

It's difficult to make these types of content changes in isolation, and I needed to look at the whole picture. As such, the pull request is quite large, but I'll add notes to explain some of the bigger changes.

These changes are for:

  • new users starting for the homepage
  • existing users starting from the migration guide

The new customisation guide bridges the gap between our getting started guide (which sets our users up with the bare minimum) and our comprehensive but dense documentation (i.e. lists of rules, options and configuration properties). The guide highlights:

  • a few of the capabilities of the rules not turned on the in the standard config
  • that there are custom rules that can be used via shared configs or plugins directly
  • a few useful options like --fix and `--cache

It acts as a gateway for users to explore further and it’s not meant to be comprehensive. It highlights some of the customisations that our users may like to try out first and hints at what Stylelint is capable of as a linter.

It also removes lists of 3rd party things into Awesome Stylelint . It was previously arbitrary what lists we had in the main docs and what we put in awesome Stylelint; this led to integrations having more prominence than plugins in our docs. 3rd party things are still mentioned in examples to provide context, though.

Other changes were made to make the docs consistent in tone, terminology, structure and conciseness.

Also fixes issues picked up by Grammarly while I was reading through all the pages.

(I've got a few days of issues and pull requests to catch up, which I hope to do over the coming days...)

@changeset-bot
Copy link

changeset-bot bot commented Jan 10, 2023

⚠️ No Changeset found

Latest commit: f48af19

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/developer-guide/plugins.md Show resolved Hide resolved
docs/developer-guide/rules.md Show resolved Hide resolved
docs/maintainer-guide/issues.md Show resolved Hide resolved
docs/user-guide/combine.md Show resolved Hide resolved
docs/user-guide/configure.md Show resolved Hide resolved
docs/user-guide/configure.md Outdated Show resolved Hide resolved
docs/user-guide/configure.md Show resolved Hide resolved
docs/user-guide/configure.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/user-guide/configure.md Outdated Show resolved Hide resolved
docs/user-guide/configure.md Outdated Show resolved Hide resolved
docs/user-guide/configure.md Outdated Show resolved Hide resolved
docs/developer-guide/plugins.md Show resolved Hide resolved
docs/developer-guide/rules.md Outdated Show resolved Hide resolved
docs/migration-guide/to-15.md Outdated Show resolved Hide resolved
docs/migration-guide/to-15.md Outdated Show resolved Hide resolved
docs/user-guide/customize.md Outdated Show resolved Hide resolved
docs/user-guide/get-started.md Outdated Show resolved Hide resolved
docs/user-guide/get-started.md Show resolved Hide resolved
jeddy3 and others added 8 commits January 22, 2023 16:17
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
@jeddy3
Copy link
Member Author

jeddy3 commented Jan 24, 2023

Thanks for the reviews, everyone. I've accepted the suggestions and made commits for the other pieces of feedback.

@ybiquitous A big thank you for all the catches. You spotted lots!

Any more feedback or can we merge?

Copy link
Member

@ybiquitous ybiquitous left a comment

Choose a reason for hiding this comment

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

@jeddy3 Thank you so much for the many document updates! LGTM 👍🏼

@jeddy3 jeddy3 merged commit e488111 into v15 Jan 25, 2023
@jeddy3 jeddy3 deleted the prepare-15-docs branch January 25, 2023 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Prepare 15.0.0
4 participants