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.

Sign up for GitHub

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

Jump to bottom

Add docs #32

Merged
merged 9 commits into from
Nov 10, 2023
Merged

Add docs #32

merged 9 commits into from
Nov 10, 2023

Conversation

pat-s
Copy link
Contributor

@pat-s pat-s commented Oct 26, 2023

Same as #25

pat-s and others added 2 commits October 14, 2023 23:25
@pat-s
init
52d35ca
@pat-s @qwerty287
Update docs.md
369546f 
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
anbraten
anbraten reviewed Oct 29, 2023
View reviewed changes
docs.md Outdated Show resolved Hide resolved
docs.md Outdated Show resolved Hide resolved
docs.md Outdated Show resolved Hide resolved
docs.md Outdated Show resolved Hide resolved
@anbraten anbraten added the documentation Improvements or additions to documentation label Nov 10, 2023
anbraten
anbraten approved these changes Nov 10, 2023
View reviewed changes
Copy link
Member

@anbraten anbraten left a comment

Choose a reason for hiding this comment

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

Updated the settings accordingly to the state after #46 will be merged

If you are fine with the changes I did to it, feel free to merge once #46 got merged @pat-s

pat-s
pat-s commented Nov 10, 2023
View reviewed changes
docs.md Outdated Show resolved Hide resolved
pat-s
pat-s commented Nov 10, 2023
View reviewed changes
Copy link
Contributor Author

@pat-s pat-s left a comment

Choose a reason for hiding this comment

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

What I am still not so sure about is that this plugin redirects the settings to comments in code rather than using a docs.md table like all other plugins. This results in an MD table missing on the plugin's website page and makes it go somewhat out of line.

@anbraten
Copy link
Member

anbraten commented Nov 10, 2023 •
edited
Loading

What I am still not so sure about is that this plugin redirects the settings to comments in code rather than using a docs.md table like all other plugins. This results in an MD table missing on the plugin's website page and makes it go somewhat out of line.

It has the table for the "normal" settings as most other plugins in the docs. However the additional and optional file config contains typescript types of the parameters etc which are really important IMO especially if you want to configure hooks. It is somehow like the documentation of the renovate / prettier configs which would not be described in the docs.md as well.

@anbraten anbraten merged commit ab9efa6 into main Nov 10, 2023
3 checks passed
@anbraten anbraten deleted the docs branch November 10, 2023 19:44
@woodpecker-bot woodpecker-bot mentioned this pull request Nov 10, 2023
Merged
@woodpecker-bot
Copy link
Contributor

🎉 This PR is included in version 1.0.0 🎉

The release is now available here

Thank you for your contribution. ❤️📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anbraten anbraten anbraten approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pat-s @anbraten @woodpecker-bot