Skip to content

Test @inline tag - #3099

Draft
drtangible wants to merge 1 commit into
mainfrom
drtangible/wip-test-inline-tag
Draft

Test @inline tag#3099
drtangible wants to merge 1 commit 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 · +14 −0
Customruntimeid Added · +22 −0
Registercustomruntimeoptions Added · +48 −0
Toolendoptions Added · +54 −0
Jsonobject Added · +14 −0
Jsonvalue Added · +10 −0
Registercustomruntimeresult Added · +8 −0
Typescript Sdk Changed · +7 −0
Dataset Changed · +22 −12
Evaluation Changed · +42 −12
Evaluationlogger Changed · +28 −6
Messagesprompt Changed · +20 −10
Objectref Changed · +9 −9
Scorelogger Changed · +5 −5
Stringprompt Changed · +20 −10
… and 80 more

Updated 2026-08-24 15:49:06 UTC for deployment · fa61f9c.

@github-actions

Copy link
Copy Markdown
Contributor

Readability impact

Word-weighted Flesch-Kincaid grade change across 36 changed pages: +0.1 (harder).

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 8.5 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/classes/evaluation.mdx 9.0 9.1 +0.1 -0.5 harder
weave/reference/typescript-sdk/classes/evaluationlogger.mdx 12.8 12.8 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/classes/messagesprompt.mdx 7.5 7.5 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/classes/objectref.mdx 8.7 8.7 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/classes/scorelogger.mdx 13.1 13.1 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/classes/stringprompt.mdx 6.9 6.9 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/classes/weaveadkplugin.mdx 10.5 10.5 +0.0 -0.2 unchanged
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 9.9 +0.0 +0.0 unchanged
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.0 +0.0 +0.0 unchanged
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.6 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/functions/instrumentopenaiagents.mdx 12.8 12.8 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/functions/login.mdx 7.2 7.2 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/functions/op.mdx 7.2 8.1 +0.9 +0.2 harder
weave/reference/typescript-sdk/functions/patchrealtimesession.mdx 8.5 8.5 +0.0 +0.0 unchanged
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 9.7 +0.0 +0.0 unchanged
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 6.2 +0.0 +0.0 unchanged
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 9.7 n/a
weave/reference/typescript-sdk/functions/withattributes.mdx 13.3 13.3 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/functions/wrapclaudeagentsdk.mdx 11.6 11.6 +0.0 +0.0 unchanged
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 20.6 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/interfaces/callsfilter.mdx 21.7 21.7 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/interfaces/conversation.mdx 13.6 13.6 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/interfaces/conversationinit.mdx 12.6 12.8 +0.2 -1.5 harder
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 10.7 10.7 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/interfaces/httpresponse.mdx 14.4 14.4 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/interfaces/httpvalidationerror.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/llm.mdx 8.2 8.2 +0.0 +0.0 unchanged
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 9.6 n/a
weave/reference/typescript-sdk/interfaces/sortby.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/subagent.mdx 7.5 7.6 +0.1 +0.0 harder
weave/reference/typescript-sdk/interfaces/subagentinit.mdx too little prose to score
weave/reference/typescript-sdk/interfaces/tool.mdx 7.3 7.9 +0.6 -3.4 harder
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 7.3 +0.0 +1.3 unchanged
weave/reference/typescript-sdk/interfaces/turninit.mdx 11.6 n/a
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 9.0 -0.2 +2.9 easier
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 12.2 12.2 +0.0 +0.0 unchanged
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 12.4 12.4 +0.0 +0.0 unchanged
weave/reference/typescript-sdk/type-aliases/opdecorator.mdx 20.7 20.7 +0.0 +0.0 unchanged
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 8.2 -0.1 +1.4 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 12.3 +0.6 -4.4 harder

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 2 +0
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 3
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/op.mdx 3 3 +0
weave/reference/typescript-sdk/interfaces/subagent.mdx 3 3 +0
weave/reference/typescript-sdk/classes/evaluationlogger.mdx 3 3 +0
weave/reference/typescript-sdk/interfaces/tool.mdx 3 3 +0

Pages showing — could not be rated: Expecting ',' delimiter: line 1 column 389 (char 388)

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

From workflow run 32746769102

@github-actions

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/weave/reference/typescript-sdk

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