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

Improve the documentation #65

Open
aperezg opened this issue Oct 2, 2020 · 2 comments
Open

Improve the documentation #65

aperezg opened this issue Oct 2, 2020 · 2 comments
Assignees
Labels
Milestone

Comments

@aperezg
Copy link
Member

aperezg commented Oct 2, 2020

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.

@tisuela
Copy link

tisuela commented Oct 2, 2020

Yo I am down to help. I have experience with Github Pages (my work) and Material for MkDocs (my work)

Both of these solutions would work with creating a doc/ directory! Click on the "my work" links for examples!

@joanlopez joanlopez self-assigned this Oct 3, 2020
@joanlopez
Copy link
Member

Hey @nananananate,

Thanks for your interest! I'm near to publish the v0 of the new Killgrave docs page. So, once it gets published, feel free to contribute with improvements.

We'd really appreciate it! 👌🏻

@joanlopez joanlopez added this to the v0.5.0 milestone Feb 13, 2021
@aperezg aperezg modified the milestones: v0.5.0, 0.5.1 May 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants