docs(api): TRA-809 — BB1 hygiene (Try-it wording, versioning enum gap, codegen version unmangle)#188
Merged
Merged
Conversation
- F2: drop "Try it" / "try-it-now widget" wording from authentication and quickstart; Redoc is a read-only renderer with no request console - F3: add `invalid_context` to versioning's open-extensible-enums field-code list to match the errors catalog and the FieldErrorCode enum (was 10 of 11 codes) - F5: render the `datamodel-codegen` pinned version with a space instead of a bare `@` so Cloudflare's email-obfuscation pass on the docs origin stops rewriting it to a `[email protected]` placeholder for raw-HTML / no-JS / view-source / scraper consumers Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
🚀 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 |
github-actions Bot
added a commit
that referenced
this pull request
May 23, 2026
…ioning enum gap, codegen version unmangle)
Deploying docs with
|
| Latest commit: |
8ed9e08
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e39e5126.docs-4n7.pages.dev |
| Branch Preview URL: | https://docs-tra-809-bb1-hygiene.docs-4n7.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three pre-launch docs hygiene items from the BB1 black-box cycle (post asset-location-removal). All presentation-layer; no service behavior change. None blocks launch — grouped as one cleanup pass.
authentication.mdandquickstart.mdx./apirenders with Redoc, a read-only reference with no request console; the auth page now leads with the curl recipe directly. Swapping the renderer for a console-bearing one (Swagger UI / Scalar) is a separate product decision out of scope here.invalid_contextto the versioning page's open-extensible-enums field-code list. The page enumerated 10 of the 11 currentFieldErrorCodevalues; an integrator building an exhaustive matcher from this list would silently omit a real production code.datamodel-codegenversion with a space instead of a bare@(datamodel-codegen 0.57.0). The docs origin's Cloudflare email-obfuscation pass was rewriting the digit-bearing@pattern to a[email protected]placeholder for raw-HTML / no-JS / view-source / reader-mode / scraper consumers — exactly the automated-integrator audience the API targets. Disabling the Cloudflare rule on the docs path is a config change tracked separately and not required for this fix.The spec-generator
x-originalParamNameartifact called out in the same finding ships intrakrf/platformPR #392 (out of scope for this repo).Files
docs/api/authentication.md— F2docs/api/quickstart.mdx— F2 + F5docs/api/versioning.md— F3docs/api/design-notes.md— F5docs/api/changelog.md— BB1 hygiene entryTest plan
pnpm build— clean (anchors resolve, broken-link check enforced viaonBrokenLinks: throw)pnpm typecheck— cleanpnpm dlx prettier --checkon touched files — cleandatamodel-codegen 0.57.0(not a[email protected]placeholder) on the deployed preview when viewed with view-source / no-JS / curl🤖 Generated with Claude Code