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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/docs #311

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

Theoreticallyhugo
Copy link
Contributor

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.

  • the installation, which ive split off, but not changed in any way beyond that
  • the color theming, which was added in a previous pr
  • the CONFIG.md which explains every configuration option besides color theming

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.

@fvincenzo
Copy link
Contributor

@Theoreticallyhugo Amazing job! I will put some time away over the weekend to review your series! 😄 I might learn something new!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants