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

Publish kdocs on gh-pages or some other site #22

Closed
simonsickle opened this issue Sep 8, 2020 · 3 comments · Fixed by #24
Closed

Publish kdocs on gh-pages or some other site #22

simonsickle opened this issue Sep 8, 2020 · 3 comments · Fixed by #24
Labels
documentation Something needs more documentation enhancement New feature or request

Comments

@simonsickle
Copy link

simonsickle commented Sep 8, 2020

As a user of the library, I would like to see all of the documentation in an easy place such as github pages. This would allow me to see things not documented in the readme like the awesome support for backoff retries in the network response.

Since the library is open source, github actions could be used to do this automatically on push

@haroldadmin haroldadmin added documentation Something needs more documentation enhancement New feature or request labels Sep 27, 2020
@haroldadmin
Copy link
Owner

Excellent idea! I will try to setup a small documentation website today. I refrained from creating one earlier because the README contains basically all the information you need to know.

Having a website with docs, usage examples, and API reference would be awesome. I'll try to put something together over the weekend. No ETA though.

@haroldadmin
Copy link
Owner

Project documentation is now available at https://haroldadmin.github.io/NetworkResponseAdapter/

@simonsickle
Copy link
Author

Thanks for this! I truly appreciate you doing this and the docs look awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something needs more documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants