Weave generated reference improvements #1889

mdlinville · 2025-11-18T22:37:49Z

Description

Fix Weave generation reference bugs discovered in #1888

Second commit fixes some further issues seen in testing in my fork.

TODO: Remove the WEAVE-REFERENCE-FIXES-SUMMARY.md which summarizes the issues found and fixed

Followup needed upstream

❌ reproduced the Python root module changes so that is a code thing, not sure if it was intended or not (truncation of the python-sdk.mdx landing page).
❌ reproduced breaking API changes between v0.52.10 and v0.52.16, needs subsequent docs updates if intended.

Fixes

✅ Worked around upstream duplicate H3 issue in Service API spec by updating the scripts to delete the previous generated files before generating them again from fresh, rather than appending new changes. This will look like a one-time fix in the regeneration PR's diff.
✅ Fixed malformed horizontal separators
✅ Fixed Typescript file casing issues
✅ Fixed service API H1 issue
✅ Fixed inadvertent modification of Models references
✅ Fixed OpenAPI TOC change bug
✅ Fixed section grouping bug from Core to Other
✅ Fixed Service API spec URL, define it only once
✅ Deal with curly braces in incoming Weave refs so that the .mdx outputs are valid
✅ With all of the fixes in place, mint broken-links now passes, so the link-rot check should also pass.

Features

✨The fetched OpenAPI spec is now validated upon download, seems to be working.

Testing

Ran the scripts locally to regenerate the references and validate the fixes
Local build succeeds without errors (mint dev) after generating the refs fresh
Local link check succeeds without errors (mint broken-links)
PR tests succeed

Note that PR checks won't be interesting because this doesn't update any .mdx files.

github-actions · 2025-11-18T22:40:14Z

📚 Mintlify Preview Links

🔗 View Full Preview

🔄 Renamed/Moved (15 total)

📄 Pages (15)

Old Path → New Path	Preview
`weave/reference/typescript-sdk/classes/Dataset.mdx` → `weave/reference/typescript-sdk/classes/dataset.mdx`	Dataset
`weave/reference/typescript-sdk/classes/Evaluation.mdx` → `weave/reference/typescript-sdk/classes/evaluation.mdx`	Evaluation
`weave/reference/typescript-sdk/classes/ScoreLogger.mdx` → `weave/reference/typescript-sdk/classes/scorelogger.mdx`	Scorelogger
`weave/reference/typescript-sdk/classes/WeaveClient.mdx` → `weave/reference/typescript-sdk/classes/weaveclient.mdx`	Weaveclient
`weave/reference/typescript-sdk/functions/requireCurrentCallStackEntry.mdx` → `weave/reference/typescript-sdk/functions/requirecurrentcallstackentry.mdx`	Requirecurrentcallstackentry
`weave/reference/typescript-sdk/functions/requireCurrentChildSummary.mdx` → `weave/reference/typescript-sdk/functions/requirecurrentchildsummary.mdx`	Requirecurrentchildsummary
`weave/reference/typescript-sdk/functions/weaveAudio.mdx` → `weave/reference/typescript-sdk/functions/weaveaudio.mdx`	Weaveaudio
`weave/reference/typescript-sdk/functions/weaveImage.mdx` → `weave/reference/typescript-sdk/functions/weaveimage.mdx`	Weaveimage
`weave/reference/typescript-sdk/functions/wrapOpenAI.mdx` → `weave/reference/typescript-sdk/functions/wrapopenai.mdx`	Wrapopenai
`weave/reference/typescript-sdk/interfaces/CallSchema.mdx` → `weave/reference/typescript-sdk/interfaces/callschema.mdx`	Callschema
... and 5 more pages

✨ Added (9 total)

📄 Pages (9)

File	Preview
`weave/reference/python-sdk/weave/index.mdx`	Weave
`weave/reference/python-sdk/weave/trace/op.mdx`	Op
`weave/reference/python-sdk/weave/trace/weave_client.mdx`	Weave Client
`weave/reference/python-sdk/weave/trace_server/trace_server_interface.mdx`	Trace Server Interface
`weave/reference/typescript-sdk/classes/evaluationlogger.mdx`	Evaluationlogger
`weave/reference/typescript-sdk/classes/messagesprompt.mdx`	Messagesprompt
`weave/reference/typescript-sdk/classes/objectref.mdx`	Objectref
`weave/reference/typescript-sdk/classes/stringprompt.mdx`	Stringprompt
`weave/reference/typescript-sdk/classes/weaveobject.mdx`	Weaveobject

📝 Changed (7 total)

📄 Pages (6)

File	Preview
`weave/guides/tracking/tracing.mdx`	Tracing
`weave/reference/service-api.mdx`	Service Api
`weave/reference/typescript-sdk.mdx`	Typescript Sdk
`weave/reference/typescript-sdk/functions/init.mdx`	Init
`weave/reference/typescript-sdk/functions/login.mdx`	Login
`weave/reference/typescript-sdk/functions/op.mdx`	Op

⚙️ Other (1)

File
`docs.json`

🗑️ Deleted (4 total)

View deleted files

📄 Pages (4)

File
`weave/reference/typescript-sdk/classes/EvaluationLogger.mdx`
`weave/reference/typescript-sdk/classes/MessagesPrompt.mdx`
`weave/reference/typescript-sdk/classes/StringPrompt.mdx`
`weave/reference/typescript-sdk/classes/WeaveObject.mdx`

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 9a90770 at 2025-11-25 19:30:39 UTC

Observed in #1888

Fixes issues from PR review: - Add weave/reference/python-sdk as first page in Python SDK section - Add weave/reference/typescript-sdk as first page in TypeScript SDK section - Remove service-api/index.mdx generation (landing page is service-api.mdx) - Keep OpenAPI config managed by sync_openapi_spec.py only This ensures proper navigation structure in docs.json.

Prepare for cherry-pick by removing old capitalized file names. New lowercase versions will be added via cherry-pick.

… links - Updated generate_typescript_sdk_docs.py to generate lowercase filenames - Regenerated all Weave reference documentation - Fixed broken links in typescript-sdk.mdx landing page (WeaveClient -> weaveclient, etc.) - Fixed broken link in weave/guides/tracking/tracing.mdx - Added new classes: ObjectRef - Added new functions: requirecurrentcallstackentry, requirecurrentchildsummary, weaveaudio, weaveimage, wrapopenai - Updated Service API spec and landing page - Updated docs.json TOC This resolves the 22 broken links caused by case mismatch between generated files and links.

- Updated generate_python_sdk_minimal.py to escape curly braces in docstrings - Curly braces are interpreted as JSX expressions in MDX, so they need to be escaped - Regenerated Python SDK documentation with escaped braces - This fixes the three Mintlify parsing errors: * op.mdx line 24: Could not parse expression with acorn * index.mdx line 3112: Could not parse expression with acorn * weave_client.mdx line 312: Unexpected lazy line in expression

- Python SDK: Remove Pydantic documentation links that reference non-existent concept pages - TypeScript SDK: Fix relative link paths when extracting functions and type aliases * Landing page links use ./typescript-sdk/ prefix * Function/type-alias pages use ../ relative paths - Updated both generators to properly handle link transformations - This fixes 783 broken links reported by the link checker

- Convert typescript-sdk#anchor links to proper relative paths - Function files: (typescript-sdk#op) -> (../type-aliases/op) - Type alias files: (typescript-sdk#op) -> (./op) - This fixes the 6 broken links in op.mdx that reappeared

mintlify bot deployed to staging November 18, 2025 22:39 View deployment

This was referenced Nov 18, 2025

Update Weave reference documentation (Weave 0.52.16) #1888

Draft

Weave generated reference improvements mdlinville/docs#48

Merged

mintlify bot deployed to staging November 19, 2025 00:09 View deployment

mdlinville marked this pull request as ready for review November 25, 2025 17:21

mdlinville requested a review from a team as a code owner November 25, 2025 17:21

mintlify bot deployed to staging November 25, 2025 17:22 View deployment

mdlinville mentioned this pull request Nov 25, 2025

Regenerate Weave refs #1922

Closed

mdlinville added 4 commits November 25, 2025 09:55

Fix Weave reference generation bugs

ae576d9

Observed in #1888

Fix Service API spec URL, define it only once in the script

8f37189

Remove old capitalized TypeScript SDK files from tracking

ee47c9f

Prepare for cherry-pick by removing old capitalized file names. New lowercase versions will be added via cherry-pick.

mdlinville force-pushed the weave_generated_reference_improvements branch from caad229 to ee47c9f Compare November 25, 2025 17:56

mintlify bot deployed to staging November 25, 2025 17:57 View deployment

mintlify bot deployed to staging November 25, 2025 18:29 View deployment

mintlify bot deployed to staging November 25, 2025 18:33 View deployment

mintlify bot deployed to staging November 25, 2025 18:49 View deployment

mdlinville added 2 commits November 25, 2025 11:24

Fix more relative link paths

532a9d0

mintlify bot deployed to staging November 25, 2025 19:30 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Weave generated reference improvements #1889

Weave generated reference improvements #1889

mdlinville commented Nov 18, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Nov 18, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Weave generated reference improvements #1889

Are you sure you want to change the base?

Weave generated reference improvements #1889

Conversation

mdlinville commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Followup needed upstream

Fixes

Features

Testing

Uh oh!

github-actions bot commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Mintlify Preview Links

🔄 Renamed/Moved (15 total)

📄 Pages (15)

✨ Added (9 total)

📄 Pages (9)

📝 Changed (7 total)

📄 Pages (6)

🗑️ Deleted (4 total)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mdlinville commented Nov 18, 2025 •

edited

Loading

github-actions bot commented Nov 18, 2025 •

edited

Loading