docs: improve linters page #1995
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bombsimon
approved these changes
May 17, 2021
There was a problem hiding this comment.
It looks like it's almost as much info (if not more) in .golangci.example.yml so not sure I get the first bullet about too much info, although it makes way more sense to list the example file rather than this projects configuration. Also really nice to duplicate each linter's settings and display that close to the list of linters.
SeigeC
pushed a commit
to SeigeC/golangci-lint
that referenced
this pull request
Apr 4, 2023
* TOC level 3 * drop `.golangci.yaml` from the Configuration page * generate a dedicated configuration section for each linters. * fix changelog heading
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
.golangci.yamlin the Configuration page https://golangci-lint.run/usage/configuration, because it's useless.The modification of the TOC is inspired by https://github.com/Rocketseat/gatsby-themes/blob/7202b7529c2c2b8347ba28a7e56c442881067e91/%40rocketseat/gatsby-theme-docs/src/components/Docs/TOC/index.js
As the Rocketseat theme has been added in only one commit #1096 it's hard to resync the theme with its latest version.
screenshot