inklet documentation

The public documentation for the inklet TypeScript SDK and HTTP API. The site is built with Next.js and Fumadocs.

Source of truth

• content/ contains the user-facing guides and SDK workflows.
• contracts/public-api.yaml contains the curated public HTTP contract. Fumadocs generates the entire /http reference section from this file.
• Type tables in the SDK reference are generated from the published @inklethq/sdk declaration files pinned in package.json. <SdkType /> is only used for types the pinned release still describes correctly; anything newer is written out as a TypeScript block in the page until the release carrying it is on npm and the pin is moved.
• Internal endpoints, deployment details, and operational notes belong in the private docs-dev site, not in this repository.

This separation is intentional: the public site documents stable behavior, while implementation details remain private.

Development

pnpm install
pnpm dev

Useful checks:

pnpm types:check
pnpm build
pnpm check

Updating the reference

1. Publish the SDK version that contains the new public types.
2. Update @inklethq/sdk in package.json.
3. Replace the hand-written TypeScript blocks for those types with <SdkType />, and add any new source file to the file union in components/mdx.tsx.
4. Update contracts/public-api.yaml for HTTP-level changes.
5. Update the relevant guide in content/ when behavior or workflows change.
6. Run pnpm check and verify both the SDK and HTTP reference pages locally.

Do not copy the internal API schema wholesale into this repository. Review the contract and expose only the stable endpoints and fields intended for SDK users.