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 documentation #45

Open
btel opened this issue Oct 1, 2020 · 1 comment
Open

improve documentation #45

btel opened this issue Oct 1, 2020 · 1 comment

Comments

@btel
Copy link
Owner

btel commented Oct 1, 2020

What

Documentation is essential for every project. Read through the docs and find any errors, undocumented functions and maybe add more tutorials, examples

How

the docs are available at https://svgutils.readthedocs.io/en/latest/index.html, go through them and if you want to modify anything check click on "edit on github" in the upper right corner and edit the file directly through github interface. you don't even need to clone the repository locally, most things can be done from the browser.

if you haven't used sphinx and restructured text check out the tutorials:

https://www.sphinx-doc.org/en/master/usage/quickstart.html

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

@abhisht51
Copy link
Contributor

I am making a few changes like changing the tone of the document and turning it into third person.

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

No branches or pull requests

3 participants