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.

Sign up for GitHub

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

Jump to bottom

[Documentation]: Create an API documentation Site #33

Open
rogueloop opened this issue Oct 14, 2024 · 5 comments
Open

[Documentation]: Create an API documentation Site #33

rogueloop opened this issue Oct 14, 2024 · 5 comments
Assignees
@rogueloop
Labels
assigned Already assigned to someone, don't work on the same issue documentation Improvements or additions to documentation feature A new feature, or modifications to an existing one hack Hacktoberfest

Comments

@rogueloop
Copy link

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 GitHub Actions
Copy link

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
Copy link
Owner

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 Jesulayomy added documentation Improvements or additions to documentation hack Hacktoberfest assigned Already assigned to someone, don't work on the same issue feature A new feature, or modifications to an existing one labels Oct 14, 2024
@Jesulayomy
Copy link
Owner

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

@rogueloop
Copy link
Author

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

@rogueloop
Copy link
Author

Linking the MR here #36

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rogueloop rogueloop

Labels
assigned Already assigned to someone, don't work on the same issue documentation Improvements or additions to documentation feature A new feature, or modifications to an existing one hack Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rogueloop @Jesulayomy