-
-
Notifications
You must be signed in to change notification settings - Fork 13
docs: Rewrite docs #25
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
Conversation
abb6068
to
fb65cc5
Compare
@Munawwar @donkeyDau As I've been chatting to the both of you about these docs, if either of you have a couple minutes to donate to skim this, I'd greatly appreciate it. Let me know if I missed anything, anything's unclear, etc. There are some awkward parts of the API that I have (loose) plans to fix, so admittedly there might still be some oddities, but hopefully these docs at least let you build something with the lib. Format still tbd, I might rearrange some stuff. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙇 Thanks a lot. This increases understanding and insight into the package. Please check if some of my suggestions suit you.
Co-authored-by: donkeyDau <[email protected]>
Final missing thing here is a note on how to render a URL from server side. I don't know if there is hard dependency on global |
Yeah was going to add that little helper I showed in a separate PR, then figure out how to add that to the docs here. There's technically not a hard dependency on |
Co-authored-by: Munawwar <[email protected]>
Co-authored-by: donkeyDau <[email protected]>
No description provided.