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

Add documentation #22

Closed
anapaulagomes opened this issue Oct 23, 2020 · 1 comment
Closed

Add documentation #22

anapaulagomes opened this issue Oct 23, 2020 · 1 comment

Comments

@anapaulagomes
Copy link

Thanks for creating such nice extension! 🏆 I'd like to list here what I think would be nice to have in a documentation page.

  • Introduction: What this extension is about and which problem it solves
  • How to install the extension
  • Examples
  • Troubleshooting

The README already have most of it covered but it's handy to have a documentation where we can search for terms, see the pages available and go directly for what we're looking for.
Here a nice example of documentation: https://dramatiq.io/ (IMHO) They use Sphinx to generate it.

@cuducos
Copy link
Member

cuducos commented Nov 9, 2020

Closed by #23

@cuducos cuducos closed this as completed Nov 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants