Context
Right now the tool Killgrave is using for differents companies and users, but the documentation on the repository is very poor with a very little examples. We need to improve that point to bring closer this amazing tool to more people.
Proposed implementation
The idea will be to create a doc/ directory, with an index on the main README.md listing all the features that Killgrave have.
So inside of doc/ folder we will create a pages for this features using markdown, giving a examples of how to use the tool in each case.
In this two issues, we have examples of how to use features that doesn't have any documentation yet:
If you are insteresing on participate in this task, let us know we could create a group on discord, slack or whatever to discuss the topic and organize the documentation.
Context
Right now the tool
Killgraveis using for differents companies and users, but the documentation on the repository is very poor with a very little examples. We need to improve that point to bring closer this amazing tool to more people.Proposed implementation
The idea will be to create a
doc/directory, with an index on the mainREADME.mdlisting all the features thatKillgravehave.So inside of
doc/folder we will create a pages for this features using markdown, giving a examples of how to use the tool in each case.In this two issues, we have examples of how to use features that doesn't have any documentation yet:
If you are insteresing on participate in this task, let us know we could create a group on discord, slack or whatever to discuss the topic and organize the documentation.