Add docs #4
Merged
Add docs #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
roznawsk
temporarily deployed
to
github-pages
GitHub Actions
Inactive
roznawsk
temporarily deployed
to
github-pages
GitHub Actions
Inactive
sgfn
reviewed
Sep 15, 2023
There was a problem hiding this comment.
Looks good. A couple of ideas for improvement:
- Not related to this PR, but you could make the RoomApi constructor use
localhost:5002anddevelopmentby default, like we do in Elixir SDK - The deployed documentation is a great addition and helps quite a bit, but I still think we need to add more details in heredocs of functions, specifically those like
create_roomwhich return something the user might not expect -- the example is nice, but it might easily be overlooked - Nitpick, but the lack of capitalisation in the title of the deployed page triggers my OCD 😅
IMOJellyfish API Documentationwould look better
roznawsk
temporarily deployed
to
github-pages
GitHub Actions
Inactive
roznawsk
temporarily deployed
to
github-pages
GitHub Actions
Inactive
sgfn
approved these changes
Sep 15, 2023
Co-authored-by: Jakub Pisarek <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.