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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(config options): rewrite allowedVersions #29014

Conversation

HonkingGoose
Copy link
Collaborator

Changes

  • Rewrite allowedVersions config option docs:
    • Use headings to separate different concepts/features
    • Focus on the reader, use words like you to draw the reader in
    • Hammer home the key point that you must begin and end your regex with the / character
    • Use the word must when a user must do something
    • Be clear about who does what

Context

Inspired by a user having problems with their regex in this discussion:

I read the allowedVersions docs to try to help the user figure out what's wrong. I missed the key point about the / character in the regex when skimming the docs. If I'm reading past it, what hope do regular users have... 馃檭

I'm rewriting the docs to make it easier to skim, and hammer home the key points. 馃槃

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 May 12, 2024
Merged via the queue into renovatebot:main with commit fe45509 May 12, 2024
37 checks passed
@HonkingGoose HonkingGoose deleted the docs/rewrite-allowedVersions-config-option branch May 12, 2024 12:39
@renovate-release
Copy link
Collaborator

馃帀 This PR is included in version 37.357.0 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

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.

None yet

3 participants