Repository navigation
docs(api): order client pages for first-time readers - #189
Merged
Merged
Conversation
Give the SwgohComlink and SwgohComlinkAsync pages the same outline: Quick Start, Connecting to Comlink, Handling Errors, Retries and Pacing, Stat Calculation, API Reference. The sync page previously opened with retry backoff details and had no quick start; it now shows how to create, use and close a client, and how to point it at a service and enable HMAC signing. The async page moves error handling ahead of retries and links to the sync page for the shared constructor and retry details. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 of 2 tasks
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.
Summary
The
SwgohComlinkandSwgohComlinkAsyncAPI pages now share one outline, so a new reader goes from creating a client to its advanced options in the same order on either page:docs/api/comlink.mdclose()), and a Connecting section coveringurlvshost/port, HMAC keys and theACCESS_KEY/SECRET_KEYfallback. Before this change the page opened with retry backoff details.docs/api/async.mdThe
#retries-and-pacinganchor, which other pages link to, is unchanged.Test plan
uv run --group docs mkdocs build --strictpasses#connecting-to-comlink,#swgoh_comlink.swgoh_comlink.SwgohComlink) exist in the built HTML🤖 Generated with Claude Code