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 #21

Open
DhruvaG2000 opened this issue Aug 3, 2022 · 2 comments
Open

Improve Documentation #21

DhruvaG2000 opened this issue Aug 3, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@DhruvaG2000
Copy link
Collaborator

The Docs folder has already been created in #20 but it is mostly written in markdown.

In future it may be better to shift to Sphinx as it will look more professional and organised. Github also can build these docs and publish them on a website. See sphinx: github pages

@DhruvaG2000 DhruvaG2000 added the documentation Improvements or additions to documentation label Aug 3, 2022
@DhruvaG2000 DhruvaG2000 changed the title Add Documentation Improve Documentation Aug 3, 2022
@DhruvaG2000 DhruvaG2000 added the good first issue Good for newcomers label Aug 3, 2022
@DhruvaG2000
Copy link
Collaborator Author

DhruvaG2000 commented Sep 25, 2022

TODOs:

@soburi
Copy link
Member

soburi commented Dec 12, 2022

PWM/ADC documentation was done in #66.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants