Skip to content

[SLOP(claude-opus-4-8-medium)] docs(inspector-tabs): mark illustrative type-shape snippets as @nocheck#5247

Open
NathanFlurry wants to merge 1 commit into
stack/slop-claude-opus-4-8-medium-docs-quickstart-clean-up-rust-quickstart-to-import-shared-actor-and-auto-download-engine-lrzpsprlfrom
stack/slop-claude-opus-4-8-medium-docs-inspector-tabs-mark-illustrative-type-shape-snippets-as-nocheck-yosxkyox
Open

[SLOP(claude-opus-4-8-medium)] docs(inspector-tabs): mark illustrative type-shape snippets as @nocheck#5247
NathanFlurry wants to merge 1 commit into
stack/slop-claude-opus-4-8-medium-docs-quickstart-clean-up-rust-quickstart-to-import-shared-actor-and-auto-download-engine-lrzpsprlfrom
stack/slop-claude-opus-4-8-medium-docs-inspector-tabs-mark-illustrative-type-shape-snippets-as-nocheck-yosxkyox

Conversation

@NathanFlurry

Copy link
Copy Markdown
Member

No description provided.

@NathanFlurry

NathanFlurry commented Jun 13, 2026

Copy link
Copy Markdown
Member Author

Stack for rivet-dev/rivet

Get stack: forklift get 5247
Push local edits: forklift submit
Merge when ready: forklift merge 5247

@claude

claude Bot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Review

This is a clean, minimal documentation fix. The change adds @nocheck to six TypeScript code fences in inspector-tabs.mdx that contain illustrative type-shape pseudo-snippets (bare object literals with inline comments) rather than valid, compilable TypeScript.

Correctness: The fix is correct. The snippets use informal notation like:

{
  id: string,         // URL-safe id
  label: string,
}

This is not valid TypeScript (a bare object expression with property type annotations and inline comments). Without @nocheck, the typecheck-code-blocks.ts integration would fail on these during CI. The annotation is the right tool here — it preserves TypeScript syntax highlighting while skipping type validation.

Consistency: The pattern matches the established convention used throughout the docs (e.g., website/src/content/docs/clients/javascript.mdx, agent-os/core.mdx, and others). No new patterns introduced.

Coverage: All six illustrative snippets in the file are updated. No misses.

No issues to flag. ✅

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