-
Notifications
You must be signed in to change notification settings - Fork 312
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
Feature/docs #311
Feature/docs #311
Conversation
@Theoreticallyhugo Amazing job! I will put some time away over the weekend to review your series! 😄 I might learn something new! |
Brilliant. Thank you.
Good idea. I wanted to get this merged right away. Feel free to send in another PR for it. By the way @Theoreticallyhugo I have requested that you be added as a maintainer, but still haven't heard anything back. I will follow up with @zenorocha |
awesome @ethancedwards8! |
I've attempted to write docs that are easy to navigate and mention every single option that is available in our project, in order to allow for easier customisation.
the docs are split into three parts.
this pr is lacking explanations on the plugins fossil and terraform, because i honestly dont know what they are doing, and i have not yet been interested in looking into them very much, as this was quite the endeavour already.
additionally ive barely changed the README.md. while i feel like the features section is lacking a concept, i also wasnt too sure how to refactor it, so ill leave that to another pr.
so, all in all, we now have docs describing all plugins and configuration options. everything is linked for easy navigation, and the plugin list is sorted alphabetically.
i was thinking about adding info on non-bash external dependencies for each plugin. please let me know what you think about that.