Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs(key-concepts/presets): rewrite #31358

Merged

Conversation

HonkingGoose
Copy link
Collaborator

Changes

  • Rewrite the key concepts page for the presets
  • Write short sentences
  • Use simple terms and phrases, where possible
  • Use lists
  • Add admonition to emphasize that the order of operations is important for presets in the "extends" array

Context

A general rewrite, plus I'm trying to resolve a old discussion. 😄

Add user suggested bit to docs, or not?

A user suggested we add this explanation to the docs:

if folks want to group by mono repo first, and then major/minor: they should import group:allNonMajor first, and then config:recommended. This gives the desired result.

I changed the quote a bit, to match current terms, and to make it more readable. But the idea is the same. 😉 Source:

I'm not sure if, or where, I should put this in the preset docs. It feels very in-depth, so if it goes in, it should go under a new sub-heading, somewhere suitable.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@rarkins rarkins added this pull request to the merge queue Sep 12, 2024
Merged via the queue into renovatebot:main with commit 49faa29 Sep 12, 2024
38 checks passed
@HonkingGoose HonkingGoose deleted the docs/21099-rewrite-key-concepts-presets branch September 14, 2024 19:19
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 19, 2024
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants