Repository navigation
Add guide pages to the doc site - #118
Merged
Merged
Conversation
Add guides for error handling, paging, subscriptions and agent mode, grouped with selecting fields under a Guides menu and linked from the home page and getting started. The paging and error handling examples were run against the Star Wars API; the subscription and agent mode snippets were compiled against the test client. The README's dependency injection and request header examples called services.SpaceXClient(...); the generated method is AddSpaceXClient.
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.
Adds four guide pages to the documentation site and fixes the README's dependency injection example.
New guides, grouped with Selecting fields under a new Guides menu:
ExecuteWithResultAsync, the error code mapping, request failures and timeouts, and queries written as text.NextPageAsync/PreviousPageAsync,GetAllPagesAsyncwithmaxPages, and theWithResultvariants.StartWithErrorsAsync, and the retry, idle-timeout and buffer options from Production-ready subscriptions (SSE + graphql-ws) and a single UTF-8 envelope parser #115.--agent, the four tools, the configuration options, what is validated before a query is sent, and the security model.The home page feature cards and Getting Started now link to them.
The paging and error handling examples were run against the Star Wars API, and the output shown is real. The subscription and agent mode snippets were compiled against the test client, and the agent configuration passes
AsAgentTools' setup checks.README: the dependency injection and request header examples called
services.SpaceXClient(...); the generated method isAddSpaceXClient.Found while writing the subscriptions guide: WebSocket subscriptions don't send
ConfigureRequest/WithAccessTokenheaders (#117). The guide recommends server-sent events when a per-user token is needed.