Documentation improvements; simplify development guide#31
Merged
Conversation
HttpServer.start_socket_server() is handled as an async task, whereas it is only responsible for initializing the server. Instead, always expect start_socket_server() to return. This commit removes task creation from documentation, test code and application examples.
Improve wording and fix typos. Simplify the demo app used in the introduction.
Remove unnecessary boilerplates, and reduce the size of route handlers to improve readability.
Avoid documentation generator when cross-compiling. Documentation is already updated automatically when publishing a new release. Suppress output generated by npx when optimizing mermaid diagrams with svgo.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.