docs: streamline README and reorganize v1.1 documentation (#306) - #328
Open
Mattsface wants to merge 5 commits into
Open
docs: streamline README and reorganize v1.1 documentation (#306)#328Mattsface wants to merge 5 commits into
Mattsface wants to merge 5 commits into
Conversation
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
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.
Why
The README has grown into a mix of quick-start documentation, transport reference material, migration guidance, endpoint documentation, and release history.
For v1.1.0, the goal is to make the README easier to scan for new users while preserving the deeper technical documentation in dedicated pages.
This also adds clear documentation for the new async client without turning the README into another full API reference.
Tracks #306.
What
docs/async.mdfor detailedAsyncMlbusagedocs/examples.mdfor longer usage examplesdocs/methods.mdTests
This PR contains documentation changes only.
The documentation was reviewed against the current
release/1.1.0API and async contract. Code examples and documented method names were checked against the current public API documentation.Normal CI should still run before merge.
Risk and impact
Risk: Minimal
There are no production code or public API changes in this PR.
The main risk is documentation becoming inaccurate or linking users to the wrong guidance, particularly while async endpoint coverage is still being finalized.
If something does go wrong, the impact should be limited to confusing or incorrect documentation. It would not change runtime behavior for existing users.