docs(console): add /console namespace (overview + quickstart + integrations + webhooks + api)#1
Open
docs(console): add /console namespace (overview + quickstart + integrations + webhooks + api)#1
Conversation
…rations + webhooks + api
User-flagged gap: console.ochk.io had /api/openapi.json + /docs/api on
its own subdomain but no entry on docs.ochk.io. Each verb has its own
/<verb> namespace; console didn't.
Added 5 pages:
/console — what console is, what it isn't, mental model
/console/quickstart — sign in → bootstrap → first delegation in 5min
/console/integrations — drop-in adapters for the 5 LLM frameworks
(anthropic / openai / vercel / langgraph / mcp)
+ the shared @orangecheck/agent-console-client
+ @orangecheck/webhook-verify
/console/webhooks — event catalog, payload shape, headers, signing
secret derivation, retry semantics, idempotency
/console/api — OpenAPI 3.1 pointer, auth schemes, route catalog,
full reason-code enum, rate-limit + same-origin
+ idempotency notes
Registered the section in DOCS_NAV (between Pledge and SDKs — console
is the commercial layer on top of the protocol verbs, not a sibling
verb). Added /console + console.ochk.io to the footer.
Each page links into the existing /agent and /sdks/* surfaces so
readers fall through to the canonical specs naturally — console docs
are a thin commercial layer, not a re-statement of the protocol.
5 new static pages built clean (yarn build).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Spec is at /api/openapi (not /api/openapi.json — that path 404s) - Interactive explorer is at /api-explorer (was /docs/api, which now 308-redirects to docs.ochk.io and is unreachable on console) - Add Admin log row to the route catalog (GET /api/admin/log) Brings the public docs in sync with what the console actually serves after PR #5 (admin log) and PR #7 (api-explorer migration). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…sole.ochk.io Until now, /console/api.mdx and /console/webhooks.mdx maintained hand-typed tables of error reasons + subscribable events. Those drifted the moment a new entry landed in oc-console-web's typed catalog without a human remembering to update mdx. This PR closes the loop: scripts/gen-catalogs.mjs (build-time fetcher) src/generated/console-catalogs.json (committed snapshot) src/components/docs/ConsoleReasonCatalog.tsx src/components/docs/ConsoleWebhookEventCatalog.tsx Wiring: - prebuild script runs gen-catalogs.mjs which fetches https://console.ochk.io/api/reasons + /api/webhook-events and writes to src/generated/console-catalogs.json. On Vercel that runs at deploy time; locally `yarn build` does the same. - Defensive: if the fetch fails (offline, console down, endpoint not yet deployed) the cached JSON is preserved — build doesn't break. Worst case: docs are one deploy stale. - The committed JSON is seeded from the typed source as of 2026-04-30 (70 reasons / 4 events) so the page renders meaningfully even before the JSON endpoints deploy on console.ochk.io. Pages updated: - /console/api.mdx — Reason Catalog table replaced by <ConsoleReasonCatalog />, rendered grouped by kind (auth / input / tenancy / method / conflict / rate / config / external / internal). - /console/webhooks.mdx — Event catalog table replaced by <ConsoleWebhookEventCatalog />, includes payload_fields per event. Pairs with oc-console-web/feat/json-catalog-endpoints which adds /api/reasons + /api/webhook-events. Together: typed source on console is the single source of truth, docs are a view, drift is mechanically impossible. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Mirrors the /console product section. Seven pages organized like the canonical OC product structure: - /me — what me.ochk.io is and isn't, where it fits in the family - /me/quickstart — five-minute integration walkthrough - /me/sdk — @orangecheck/me-client v0.4.0 reference - /me/integrations — OAuth-peer pattern, sample integrator archetypes, cross-product flows with console - /me/webhooks — reception in Node + Rust, raw-body warning, retry semantics - /me/api — every me.ochk.io HTTP endpoint with auth + rate-limit metadata - /me/custody — federation custody descriptor schema, M-of-N graduation envelope, guardian rotation. Maps to the v1.2-draft-1 oc-attest extension at FEDERATION-CUSTODY.md. DocsNav surfaces /me as a top-level product section between OC Console and SDKs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds the oc.event.fire section, version bump in metadata + h1, and a note on SignInOptions / PaymentAuthorizeOptions gaining an optional project_key field. Mirrors me.ochk.io/sdk. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Lifts the eight OrangeCheck charter commitments out of every product subdomain (me.ochk.io, console.ochk.io previously had near-identical copies) and lands them here as the canonical published version. Every product's /charter URL now redirects here. The charter binds the whole company across all products. Each commitment now explicitly notes which product surfaces it most strongly applies to (custody graduation on me.ochk.io, no-custody period on console.ochk.io, free-forever on protocol siblings, etc.) so readers see how the eight commitments translate to each surface without needing per-product duplicate pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Adds the missing
/consolenamespace to docs.ochk.io — flagged as a gap because console.ochk.io serves/api/openapi.json+/docs/apion its own subdomain but had no entry on the unified docs site.What's new
5 pages (
src/pages/console/):/console— what console is, what it isn't, mental model/console/quickstart— sign in → bootstrap → first delegation in 5min/console/integrations— adapters for Anthropic / OpenAI / Vercel AI SDK / LangGraph / MCP +@orangecheck/agent-console-client+@orangecheck/webhook-verify/console/webhooks— event catalog, payload shape, headers, signing-secret derivation, retry semantics, idempotency/console/api— OpenAPI 3.1 pointer, auth schemes, full route catalog + reason-code enum, rate-limit + same-origin + idempotency notesNav + footer updates:
DOCS_NAV, positioned between Pledge and SDKs (console is the commercial layer atop the protocol verbs, not a sibling verb)./consoleadded to the footer PROTOCOLS list.console.ochk.ioadded to the footer ECOSYSTEM list.Test plan
yarn buildclean — 5 new static pages emit (139–140 kB First Load JS each, in line with the rest of the verb pages)docs.ochk.io/console, sidebar shows the new section, footer renders both links, every internal link in the new pages resolves, every external link to npm / console.ochk.io / agent spec works.Out of scope (separate tasks)
oc-X-webs pointing toconsole.ochk.iowhere commercially relevant — tracked separately.