Skip to content

Weave TypeScript inline tag generation and updated design - #3099

Merged
dbrian57 merged 2 commits into
mainfrom
drtangible/wip-test-inline-tag
Sep 4, 2026
Merged

Weave TypeScript inline tag generation and updated design#3099
dbrian57 merged 2 commits into
mainfrom
drtangible/wip-test-inline-tag

Conversation

@drtangible

Copy link
Copy Markdown
Contributor

Description

@mintlify

mintlify Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Aug 24, 2026, 3:49 PM

Page Change
Flush Added · +18 −0
Customruntimeid Added · +20 −0
Registercustomruntimeoptions Added · +40 −0
Toolendoptions Added · +48 −0
Jsonobject Added · +16 −0
Jsonvalue Added · +12 −0
Registercustomruntimeresult Added · +10 −0
Typescript Sdk Changed · +7 −0
Dataset Changed · +17 −35
Evaluation Changed · +55 −49
Evaluationlogger Changed · +29 −31
Messagesprompt Changed · +19 −33
Objectref Changed · +13 −37
Scorelogger Changed · +16 −28
Stringprompt Changed · +19 −33
… and 80 more

Updated 2026-09-03 18:35:02 UTC for deployment · 13444f8.

@github-actions

github-actions Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Readability impact

Word-weighted Flesch-Kincaid grade change across 32 changed pages: -0.4 (easier).

Lower Flesch-Kincaid grade and higher reading ease both mean easier to read. This check is informational and never blocks a PR.

Human readability

Page FK grade before FK grade after FK Δ Reading ease Δ Direction
weave/reference/typescript-sdk.mdx 53.7 57.6 +3.9 -15.2 harder
weave/reference/typescript-sdk/classes/dataset.mdx 8.5 6.4 -2.1 +16.0 easier
weave/reference/typescript-sdk/classes/evaluation.mdx 9.0 7.4 -1.6 +14.4 easier
weave/reference/typescript-sdk/classes/evaluationlogger.mdx 12.8 11.8 -1.0 +11.0 easier
weave/reference/typescript-sdk/classes/messagesprompt.mdx 7.5 11.3 +3.8 -11.4 harder
weave/reference/typescript-sdk/classes/objectref.mdx 8.7 11.2 +2.5 -2.9 harder
weave/reference/typescript-sdk/classes/scorelogger.mdx 13.1 9.8 -3.3 +24.7 easier
weave/reference/typescript-sdk/classes/stringprompt.mdx too little prose to score
weave/reference/typescript-sdk/classes/weaveadkplugin.mdx 10.5 10.0 -0.5 +5.8 easier
weave/reference/typescript-sdk/classes/weaveobject.mdx too little prose to score
weave/reference/typescript-sdk/functions/createopenaiagentstracingprocessor.mdx too little prose to score
weave/reference/typescript-sdk/functions/createotelextension.mdx 9.9 8.8 -1.1 +12.0 easier
weave/reference/typescript-sdk/functions/endconversation.mdx too little prose to score
weave/reference/typescript-sdk/functions/endllm.mdx too little prose to score
weave/reference/typescript-sdk/functions/endturn.mdx too little prose to score
weave/reference/typescript-sdk/functions/flush.mdx too little prose to score
weave/reference/typescript-sdk/functions/flushotel.mdx 9.0 9.3 +0.3 +2.3 harder
weave/reference/typescript-sdk/functions/getcurrentconversation.mdx too little prose to score
weave/reference/typescript-sdk/functions/getcurrentllm.mdx too little prose to score
weave/reference/typescript-sdk/functions/getcurrentturn.mdx too little prose to score
weave/reference/typescript-sdk/functions/init.mdx 7.6 7.5 -0.1 +3.5 easier
weave/reference/typescript-sdk/functions/instrumentopenaiagents.mdx 12.8 12.6 -0.2 +3.5 easier
weave/reference/typescript-sdk/functions/login.mdx 7.2 7.2 +0.0 +2.8 unchanged
weave/reference/typescript-sdk/functions/op.mdx 7.2 10.2 +3.0 -7.0 harder
weave/reference/typescript-sdk/functions/patchrealtimesession.mdx 8.5 7.7 -0.8 +7.1 easier
weave/reference/typescript-sdk/functions/requirecurrentcallstackentry.mdx too little prose to score
weave/reference/typescript-sdk/functions/requirecurrentchildsummary.mdx too little prose to score
weave/reference/typescript-sdk/functions/runisolated.mdx 9.7 10.7 +1.0 +0.5 harder
weave/reference/typescript-sdk/functions/startconversation.mdx too little prose to score
weave/reference/typescript-sdk/functions/startllm.mdx too little prose to score
weave/reference/typescript-sdk/functions/startsubagent.mdx too little prose to score
weave/reference/typescript-sdk/functions/starttool.mdx 6.2 5.6 -0.6 +8.0 easier
weave/reference/typescript-sdk/functions/startturn.mdx too little prose to score
weave/reference/typescript-sdk/functions/weaveaudio.mdx too little prose to score
weave/reference/typescript-sdk/functions/weaveimage.mdx too little prose to score
weave/reference/typescript-sdk/functions/withattributes.mdx 13.3 12.9 -0.4 +3.4 easier
weave/reference/typescript-sdk/functions/wrapclaudeagentsdk.mdx 11.6 10.0 -1.6 +10.1 easier
weave/reference/typescript-sdk/functions/wrapgooglegenai.mdx too little prose to score
weave/reference/typescript-sdk/functions/wrapopenai.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/callschema.mdx 20.6 16.3 -4.3 +75.2 easier
weave/reference/typescript-sdk/interfaces/callsfilter.mdx 21.7 18.0 -3.7 +81.8 easier
weave/reference/typescript-sdk/interfaces/conversation.mdx 13.6 10.0 -3.6 +34.2 easier
weave/reference/typescript-sdk/interfaces/conversationinit.mdx 12.6 11.6 -1.0 +14.0 easier
weave/reference/typescript-sdk/interfaces/customruntimeid.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/getagentsoptions.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/getagentspansoptions.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/getagentturnoptions.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/getagentturnsoptions.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/getagentversionsoptions.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/getcallsoptions.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/httpresponse.mdx 14.4 13.6 -0.8 +26.6 easier
weave/reference/typescript-sdk/interfaces/httpvalidationerror.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/llm.mdx 8.2 6.7 -1.5 +14.1 easier
weave/reference/typescript-sdk/interfaces/llminit.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/message.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/query.mdx 20.3 n/a
weave/reference/typescript-sdk/interfaces/reasoning.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/registercustomruntimeoptions.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/sortby.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/subagent.mdx 7.5 5.7 -1.8 +16.8 easier
weave/reference/typescript-sdk/interfaces/subagentinit.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/tool.mdx 7.3 6.4 -0.9 +9.3 easier
weave/reference/typescript-sdk/interfaces/toolendoptions.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/toolinit.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/turn.mdx 7.3 6.6 -0.7 +9.5 easier
weave/reference/typescript-sdk/interfaces/turninit.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/usage.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/weaveaudio.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/weaveclient.mdx 9.2 10.2 +1.0 +2.3 harder
weave/reference/typescript-sdk/interfaces/weaveimage.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/agent.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/agentmessage.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/agentspan.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/agentturn.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/agentversion.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/getagentspansresult.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/getagentsresult.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/getagentturnresult.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/getagentturnsresult.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/getagentversionsresult.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/jsonobject.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/jsonvalue.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/messagepart.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/modality.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/op.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/opdecorator.mdx 20.7 20.0 -0.7 +2.7 easier
weave/reference/typescript-sdk/type-aliases/registercustomruntimeresult.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/response.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/role.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/session.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/sessioninit.mdx too little prose to score
weave/reference/typescript-sdk/type-aliases/settings.mdx 8.3 7.9 -0.4 +7.5 easier
weave/reference/typescript-sdk/variables/endsession.mdx too little prose to score
weave/reference/typescript-sdk/variables/getcurrentsession.mdx too little prose to score
weave/reference/typescript-sdk/variables/startsession.mdx 11.7 11.6 -0.1 +2.8 easier

AI agent comprehension

Rated 0-3 (higher is easier for an agent to parse and act on).

Page Before After Δ
weave/reference/typescript-sdk/classes/weaveadkplugin.mdx 2 3 +1
weave/reference/typescript-sdk/interfaces/weaveclient.mdx 3 3 +0
weave/reference/typescript-sdk/interfaces/query.mdx 3
weave/reference/typescript-sdk/interfaces/llm.mdx 2
weave/reference/typescript-sdk/interfaces/turn.mdx 3 3 +0
weave/reference/typescript-sdk/interfaces/httpresponse.mdx 3 3 +0
weave/reference/typescript-sdk/functions/instrumentopenaiagents.mdx 3 3 +0
weave/reference/typescript-sdk/classes/evaluationlogger.mdx 3 3 +0
weave/reference/typescript-sdk/interfaces/subagent.mdx 3
weave/reference/typescript-sdk/interfaces/tool.mdx 3 2 -1

Pages showing — could not be rated: Expecting ',' delimiter: line 1 column 431 (char 430); Expecting value: line 1 column 531 (char 530)

Curated-docs baseline median FK grade by type: conceptual 10.5, procedural 8.8, reference 9.4.

From workflow run 33791157364

@github-actions

github-actions Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Preview: https://wb-21fd5541-drtangible-wip-test-inline-tag.mintlify.site

Pull against #3099. Visual redesign of the generated TypeScript SDK
reference pages. This adds a few stock Mintlify components (built
specifically for reference docs) to the page-generation template. The
result is a much cleaner look.

<img width="1795" height="1046" alt="Screenshot 2026-09-02 at 3 25
41 PM"
src="https://github.com/user-attachments/assets/f9ff5644-846e-4009-bbea-e31c8ad091a7"
/>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
@dbrian57
dbrian57 marked this pull request as ready for review September 4, 2026 15:28
@dbrian57
dbrian57 requested a review from a team as a code owner September 4, 2026 15:28
@dbrian57 dbrian57 changed the title Test @inline tag Weave TypeScript inline tag generation and updated design Sep 4, 2026
@dbrian57
dbrian57 enabled auto-merge (squash) September 4, 2026 15:30

@dbrian57 dbrian57 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.

Reviewed and added some design updates to this branch. Dan and I have reviewed the PR and it looks good.

@dbrian57
dbrian57 merged commit 1737902 into main Sep 4, 2026
14 checks passed
@dbrian57
dbrian57 deleted the drtangible/wip-test-inline-tag branch September 4, 2026 15:31
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.

2 participants