docs: improve custom plugin docs#381
Merged
BioPhoton merged 2 commits intocode-pushup:mainfrom Jan 16, 2024
Merged
Conversation
Collaborator
|
I used myAudit is the first example that was unspecific and used file-size and lighthouse below. Should I use audit-1? For the hint about "anything". It should be mentioned in the main readme top. But always better on multiple places. Where would you suggest to put it in addition? |
Tlacenka
approved these changes
Jan 3, 2024
Collaborator
Tlacenka
left a comment
Tlacenka
left a comment
There was a problem hiding this comment.
Nice language improvements!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Slight improvements for the custom plugin section of the cli docs.
More feedback for the custom-plugin detail page:
Instead of using
MyAudit, use something actually meaningful. Also add a minimal example in the very beginning of the docs section, where you describe that you can basically implement "anything". Maybe you can specify "anything" with an actual example.