Skip to content

Refresh support package references#767

Merged
blove merged 1 commit into
mainfrom
codex/threadplane-support-docs-audit
Jul 7, 2026
Merged

Refresh support package references#767
blove merged 1 commit into
mainfrom
codex/threadplane-support-docs-audit

Conversation

@blove

@blove blove commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Clarify middleware docs across LangGraph.js and Python package surfaces, including a Python LangGraph guide.
  • Refresh licensing and telemetry generated API docs from source comments.
  • Update docs navigation, LLM context, and Python middleware README verification command.

Verification

  • npm run generate-api-docs
  • npm run generate-agent-context
  • npx nx run-many -t lint,test,build -p middleware,licensing,telemetry --skip-nx-cache
  • uv run --extra test python -m pytest -q
  • npx nx run-many -t lint,build -p website
  • npx nx e2e website --skip-nx-cache
  • git diff --check

@vercel

vercel Bot commented Jul 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
threadplane Ready Ready Preview, Comment Jul 7, 2026 2:02am

Request Review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated approval: this PR received an intelligent (AI) code review. See the review comments on this PR.

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Claude finished @blove's task in 1m 47s —— View job


PR Review

  • Gather context and read changed files
  • Review source code changes (licensing, telemetry, middleware)
  • Review docs/MDX changes
  • Post findings

This is a clean docs + JSDoc refresh. No correctness bugs, security issues, or type-safety problems found. The generated files (api-docs.json, llms-full.txt) were skipped per review scope.

Source files (licensing/telemetry) — The JSDoc additions to evaluateLicense, emitNag, runLicenseCheck, provideThreadplaneTelemetry, and ThreadplaneTelemetryService are accurate and match the implementation. The new ThreadplaneBrowserStreamErrorTelemetry interface doc correctly notes that error?: unknown is reduced to an error class before sending, which is the right thing to call out explicitly.

New guide: python-langgraph.mdx — Technically accurate. One minor inconsistency: the "Helper surface" import block includes bind_client_tools and route_after_agent alongside the lower-level utilities, but the table below it only documents the lower-level five. This mirrors the TS guide's structure, but there the section is explicitly labelled "Lower-level helpers"; without that label here, a reader scanning the table for route_after_agent won't find it. Renaming the section heading to "Lower-level helpers" (matching langgraph-client-tools.mdx) would resolve the inconsistency. Not blocking.

Fix this →

docs-config.ts — The new python-langgraph slug and updated API-reference title are consistent with the new MDX files.

llms.txt/route.ts — Python package line and install snippet are correctly added.

packages/threadplane-middleware/README.md — The updated dev command (uv venv + uv run --extra test python -m pytest -q) is correct; uv run handles implicit sync so the explicit uv venv is optional but harmless.

Overall this looks good to merge.

@blove blove merged commit 76bfe4f into main Jul 7, 2026
63 checks passed
@blove blove deleted the codex/threadplane-support-docs-audit branch July 7, 2026 02:20
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