Skip to content

Clarify example modules and deploy documentation independently - #134

Merged
ueberBrot merged 1 commit into
mainfrom
docs/clarify-examples-and-deployment
Oct 11, 2026
Merged

ueberBrot merged 1 commit into
mainfrom
docs/clarify-examples-and-deployment

Conversation

@ueberBrot

Copy link
Copy Markdown
Owner

Summary

Examples: shared contract → client setup → UI / entry point
Docs:     validated build → reused artifact → Pages deployment

Separate the README and complete RPC, HTTP, React, and tracing examples into named modules with real imports. Preserve ready-client acquisition and cleanup, and verify snippets against compiled fixtures.

Deploy documentation after successful validation on main, independently of npm publication. Keep an npm fallback until the existing registry lookup supplies the published version.

Evidence

  • Before: examples combined shared declarations with client and UI setup.
    After: named modules show their ownership and imports; public fixtures compile under TypeScript 7 and 5.9.
  • Before: docs deployment required successful package publication, and the static badge could claim an unpublished repository version.
    After: deployment reuses the validated documentation artifact; seven Chromium checks pass, including published-version and registry-failure cases.
  • Validation: 56-page docs build with matching snippets and valid internal links; package declarations, attw and publint; type-aware lint, formatting; two existing React and tracing recipe tests; skill checks with zero pending reviews. Workflow YAML parsing and branch/dependency checks passed. Commit hooks passed.

Merge Danger

Door: two-way

The changes can be reverted. After merge, validated main documentation deploys even when npm publication is skipped or fails. Publishing setup and public library behavior are unchanged.

Blast Radius: Documentation

@changeset-bot

changeset-bot Bot commented Oct 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 220864d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ueberBrot
ueberBrot merged commit 0feea99 into main Oct 11, 2026
6 checks passed
@ueberBrot
ueberBrot deleted the docs/clarify-examples-and-deployment branch October 11, 2026 18:55
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