Skip to content

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

Merged
merged 9 commits into from
Jun 27, 2024
Merged

docs: Rewrite docs #25

merged 9 commits into from
Jun 27, 2024

Conversation

rschristian
Copy link
Member

No description provided.

@rschristian
Copy link
Member Author

@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.

Copy link
Contributor

@donkeyDau donkeyDau left a 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.

@Munawwar
Copy link
Contributor

Munawwar commented Jun 21, 2024

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 location object, but as you mentioned, your experience is that stubbing location object is more reliable than any library level interfaces, as other libraries could assume it's existence. I think it is a critical bit to know and having that snippet to stub location would be useful.

@rschristian
Copy link
Member Author

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 location, but the current implementation is a tad flawed and honestly stubbing location is just a far more robust solution, so I'd like to walk back on that flawed impl.

@rschristian rschristian changed the title docs: Rewrite docs, initial pass docs: Rewrite docs Jun 24, 2024
@rschristian rschristian marked this pull request as ready for review June 27, 2024 05:53
@rschristian rschristian merged commit bd83e97 into main Jun 27, 2024
@rschristian rschristian deleted the docs/rewrite branch June 27, 2024 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

LocationProvider isn't used in all examples, making it unclear that it's required
3 participants