Skip to content

docs: port SDK implementation docs - #26

Merged
somus merged 2 commits into
mainfrom
somus/atf-28-sdk-docs
Jun 16, 2026
Merged

docs: port SDK implementation docs#26
somus merged 2 commits into
mainfrom
somus/atf-28-sdk-docs

Conversation

@somus

@somus somus commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

This pull request ports and consolidates the SDK implementation documentation into the repository. It adds three new in-depth guides (adapter-authoring.md, implementation-semantics.md, redaction.md) and significantly restructures the root README.md, the parser-source-matrix.md, and the individual package README files. The changes improve the contributor and user documentation by clarifying package boundaries, runtime semantics, redaction workflows, adapter authoring checklists, fixture policies, and verification procedures. No source code changes are introduced—the entire diff is documentation and package-level README updates.

@kody-ai

This comment has been minimized.

@stage-review

stage-review Bot commented Jun 16, 2026

Copy link
Copy Markdown

@pkg-pr-new

pkg-pr-new Bot commented Jun 16, 2026

Copy link
Copy Markdown

Open in StackBlitz

@agent-trail/adapter-kit

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/adapter-kit@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/adapter-kit@26

@agent-trail/adapters

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/adapters@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/adapters@26

@agent-trail/catalog

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/catalog@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/catalog@26

@agent-trail/core

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/core@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/core@26

@agent-trail/redact

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/redact@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/redact@26

@agent-trail/render-model

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/render-model@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/render-model@26

@agent-trail/schema

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/schema@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/schema@26

@agent-trail/sessions

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/sessions@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/sessions@26

@agent-trail/source-schemas

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/source-schemas@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/source-schemas@26

@agent-trail/store

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/store@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/store@26

@agent-trail/types

bun add https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/types@26
npm i https://pkg.pr.new/agent-trail/typescript-sdk/@agent-trail/types@26

commit: eba18a6

@kody-ai

kody-ai Bot commented Jun 16, 2026

Copy link
Copy Markdown

kody code-review Kody Rules medium

Pull Request Standard violation: The Verification section lists bun run check:biome, bun run check:types, bun run check:exports, local Markdown link check, and git diff --check without the mandatory results. Provide both exact verification commands and their output to comply with the standard.

Kody rule violation: Follow Pull Request Standards

@kody-ai

kody-ai Bot commented Jun 16, 2026

Copy link
Copy Markdown

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.

  • Validate Business Logic: Ask Kody to validate your code against business rules by adding a comment with the @kody -v business-logic command.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug
Performance
Security
Business Logic

Access your configuration settings here.

@somus
somus merged commit 049c624 into main Jun 16, 2026
7 checks passed
@somus
somus deleted the somus/atf-28-sdk-docs branch June 16, 2026 12:04
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