search

Jesulayomy / SCHub

SCHub v0.1, A school data management system to allow School administration, Teachers manage students and courses data.
https://schub.jesulayomi.tech
MIT License
3 stars 10 forks source link

[Documentation]: Create an API documentation Site #33

Open rogueloop opened 1 month ago

rogueloop commented 1 month ago

I will create an API documentation site using mkdocks which you can deploy easily using GitHub pages. It will have a testing feature "Try it" button, along with code generation in top languages.

github-actions[bot] commented 1 month ago

Hello! Thank you for deciding to contribute this issue. Make sure to use the proper tags and Title format so your issue can be easily identified. If you are solving this issue yourself please provide a way to contact you (i.e discord) or you can reach me on discord

Jesulayomy commented 1 month ago

Hi @rogueloop , I will approve this. I do want to change the API structure a bit when moving to Django. I would have to contact you about it after that is done, but you can start working right away. I haven't used mkdocs before, so please include a separate README.md in the folder you will work in to document how it can be installed and run by others.

Jesulayomy commented 1 month ago

Also do you have a discord or any public platform I can contact you through? @rogueloop

rogueloop commented 1 month ago

I have contacted you through x https://x.com/rev3rs3_h3ro

rogueloop commented 3 weeks ago

Linking the MR here https://github.com/Jesulayomy/SCHub/pull/36