Skip to content

Revise existing documentation guides - #241

Open
samuel-williams-shopify wants to merge 1 commit into
mainfrom
revise-documentation-guides
Open

Revise existing documentation guides#241
samuel-williams-shopify wants to merge 1 commit into
mainfrom
revise-documentation-guides

Conversation

@samuel-williams-shopify

@samuel-williams-shopify samuel-williams-shopify commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • expand Getting Started with clearer interface selection, response handling, connection persistence, JSON requests, timeouts, and server lifecycle
  • reorganize Testing around the managed server fixture, mock endpoints, HTTP/2, transparent endpoint replacement, and fake-client trade-offs

Validation

  • bundle exec sus: 247 passed, 3 skipped
  • executable guide scenarios: 5 passed
  • all 12 Ruby guide blocks compile
  • bundle exec bake decode:index:coverage lib: 292/292 documented
  • both guide pages rendered successfully with the Utopia static generator
  • local Pagefind indexing succeeds unpinned; the exact pinned pagefind@1.5.2 step exits through the local package proxy and is left for CI verification

Assisted-By: devx/eb0838cf-417f-4559-90ed-e9a0d84bfd2d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant