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

Can I work on your documentation? #56

Closed
sunkanmii opened this issue Nov 5, 2024 · 2 comments
Closed

Can I work on your documentation? #56

sunkanmii opened this issue Nov 5, 2024 · 2 comments
Labels
docs regarding documentation

Comments

@sunkanmii
Copy link

Hey! 👋🏾

My name is Sunkanmi, and I'm a Technical Writer looking to contribute to API documentation on Github. Is it possible for me to submit a PR for Swagger documentation for this API and help refine your Github readme as well?

Let me know if I can get started on this. :)

Hope to speak with you soon!

@derhuerst
Copy link
Owner

Hey!

There already is a Swagger/OpenAPI document, linked both via an HTTP header and in the documentation page (docs/readme.md). There is a related PR by @traines-source that fixes and tweaks it, but I still haven't found the time to review and merge it. 🙈

Regarding human-readable documentation: Sure, I appreciate the help. What do you want to improve on, specifically?

@derhuerst derhuerst added the docs regarding documentation label Nov 22, 2024
@derhuerst
Copy link
Owner

Please re-open if you still want to work on this.

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

No branches or pull requests

2 participants