Skip to content

docs(api): order client pages for first-time readers - #189

Merged
MarTrepodi merged 1 commit into
developfrom
docs/client-page-ordering
Oct 14, 2026
Merged

MarTrepodi merged 1 commit into
developfrom
docs/client-page-ordering

Conversation

@MarTrepodi

Copy link
Copy Markdown
Collaborator

Summary

The SwgohComlink and SwgohComlinkAsync API 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:

  1. Quick Start
  2. Connecting to Comlink
  3. Handling Errors
  4. Retries and Pacing
  5. Stat Calculation
  6. API Reference

docs/api/comlink.md

  • Adds an intro, a Quick Start (context manager and close()), and a Connecting section covering url vs host/port, HMAC keys and the ACCESS_KEY/SECRET_KEY fallback. Before this change the page opened with retry backoff details.
  • Adds short Handling Errors and Stat Calculation sections that link to the exceptions and StatCalc pages.
  • The retry text is unchanged; its example ally code now matches the rest of the docs.

docs/api/async.md

  • Moves error handling ahead of retries.
  • Adds a short Connecting section that links to the sync page instead of repeating it.
  • Renames "Async Stat Calculation" to "Stat Calculation" so the headings match across both pages.

The #retries-and-pacing anchor, which other pages link to, is unchanged.

Test plan

  • uv run --group docs mkdocs build --strict passes
  • New in-page anchors (#connecting-to-comlink, #swgoh_comlink.swgoh_comlink.SwgohComlink) exist in the built HTML

🤖 Generated with Claude Code

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>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 14, 2026
@MarTrepodi
MarTrepodi merged commit 9c71be1 into develop Oct 14, 2026
16 checks passed
@MarTrepodi
MarTrepodi deleted the docs/client-page-ordering branch October 14, 2026 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant