Skip to content

docs(api): TRA-892 — docs-hygiene bundle (3 one-line fixes + groom contact.url deferral)#205

Merged
mikestankavich merged 4 commits into
mainfrom
docs/tra-892-docs-bundle
May 30, 2026
Merged

docs(api): TRA-892 — docs-hygiene bundle (3 one-line fixes + groom contact.url deferral)#205
mikestankavich merged 4 commits into
mainfrom
docs/tra-892-docs-bundle

Conversation

@mikestankavich
Copy link
Copy Markdown
Contributor

TRA-892 — Docs-hygiene bundle (3 one-line fixes + groom contact.url deferral)

Four documentation-hygiene items surfaced by the 2.6.1 black-box fleet (runs bb-261/262/263, svc v1.1.1-165-g8ca09556). None gate the prod launch — zero service/contract defects were found.

Spec: superpowers/specs/2026-05-30-tra-892-docs-hygiene-bundle-design.md
Plan: superpowers/plans/2026-05-30-tra-892-docs-hygiene-bundle.md

Changes

  1. tests/blackbox/BB_PRE_KEY.md — current location is a scan projection (asset-locations report / history endpoints), not a field on the asset object; reconciled the parallel "materialized location_id" line so the doc stays consistent.
  2. docs/api/quickstart.mdx — empty PATCH {} is a no-op only against settable fields (it still advances updated_at). The full behavior was already documented at :167; this closes the gap at the compressed mention.
  3. tests/blackbox/BB.md — fetch the spec/build version from the app origin /health.json (carries version + spec_refreshed_at); the docs origin's /health.json carries only the docs build stamp.
  4. tests/blackbox/BACKLOG.md — retired the "restore info.contact.url" deferral row. The URL was restored by design (Stripe pattern, https://trakrf.id) via platform TRA-882; the deferral is obsolete. (TRA-743 is already Done — Linear groomed separately with a comment.)

Verification

  • pnpm build ✅ (Redocusaurus fetches the live spec; no spec change here)
  • prettier --check ✅ on all changed/new files
    • Note: repo-wide pnpm lint is red on pre-existing files (e.g. untouched superpowers/specs/2026-05-30-tra-891-*); not introduced by this PR and intentionally left out of scope.

Decisions (resolved autonomously)

  • Item 2: inline qualifier over "link to design note" (the block already deep-links the design note).
  • Item 3: corrected BB.md rather than surfacing API version on the docs host (the latter is an infra/build change, outside doc-hygiene scope).
  • Item 4: TRA-743 already Done → grooming = remove the stale BACKLOG row + a Linear comment, no state change.

🤖 Generated with Claude Code

Mike Stankavich and others added 3 commits May 30, 2026 15:34
…url deferral grooming

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…TCH no-op qualifier, BB version-check origin, retire contact.url deferral

Surfaced by the 2.6.1 black-box fleet (bb-261/262/263, svc v1.1.1-165-g8ca09556);
none gate launch.

1. BB_PRE_KEY.md: clarify current location is a scan projection (asset-locations
   report / history endpoints), not a field on the asset object; reconcile the
   parallel 'materialized location_id' line.
2. quickstart.mdx: empty PATCH {} is a no-op only against settable fields — it
   still advances updated_at.
3. BB.md: fetch spec/build version from the app origin /health.json (carries
   version + spec_refreshed_at); docs origin has only the docs build stamp.
4. BACKLOG.md: retire the 'restore info.contact.url' deferral — restored by
   design (Stripe pattern, https://trakrf.id) via platform TRA-882.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

🚀 Preview Deployment Update

✅ This PR has been successfully merged into the preview branch.

The preview environment will update shortly at: https://docs.preview.trakrf.id

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 30, 2026

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6838343
Status: ✅  Deploy successful!
Preview URL: https://d6b534e6.docs-4n7.pages.dev
Branch Preview URL: https://preview.docs-4n7.pages.dev

View logs

The all-bigint post-720 schema has landed (TRA-720 + the TRA-810 GKE
migration); preview/prod run on it. Both deferred-registry rows whose
trigger was 'bigint migration lands' are now resolved:

- 'Bigint storage migration' (TRA-720) — done.
- 'Path-param maximum constraint removal' (TRA-726 F2) — verified done in
  the live spec: surrogate path params now declare format: int64 +
  maximum: 9007199254740991 (no 2147483647 cap remains on any id).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

🚀 Preview Deployment Update

✅ This PR has been successfully merged into the preview branch.

The preview environment will update shortly at: https://docs.preview.trakrf.id

@mikestankavich mikestankavich merged commit 3f6e047 into main May 30, 2026
2 checks passed
@mikestankavich mikestankavich deleted the docs/tra-892-docs-bundle branch May 30, 2026 20:51
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