Skip to content

Update Weave reference documentation (Weave 0.53.7) - #3167

Closed
github-actions[bot] wants to merge 2 commits into
mainfrom
update-reference-docs-60
Closed

Update Weave reference documentation (Weave 0.53.7)#3167
github-actions[bot] wants to merge 2 commits into
mainfrom
update-reference-docs-60

Conversation

@github-actions

@github-actions github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

This PR updates the reference documentation for Weave.

Version: 0.53.7
Generated on: 2026-09-01 00:09:39 UTC
Source code: wandb/weave@0.53.7

Changes

  • Synced OpenAPI specification from remote service
  • Updated Service API landing page with current endpoints list
  • Regenerated Python SDK documentation using lazydocs (dynamically discovers all public modules)
  • Regenerated TypeScript SDK documentation using typedoc
  • Updated docs.json navigation with any new or removed modules
  • Fixed file casing for consistency
  • Fixed internal cross-reference links
  • Converted Service API endpoint links to fully qualified URLs

@github-actions github-actions Bot added automated documentation Improvements or additions to documentation weave labels Sep 1, 2026
@mintlify

mintlify Bot commented Sep 1, 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 Sep 1, 2026, 12:14 AM

Page Change
Session 1 Added · +13 −0
Python Sdk Changed · +494 −277
Remote Http Trace Server Changed · +136 −126
Trace Server Interface Changed · +775 −532
Feedback Changed · +19 −17
Op Changed · +19 −19
Util Changed · +11 −11
Weave Client Changed · +144 −65
Service Api Changed · +4 −0
Typescript Sdk Changed · +1 −0
No preview available (1)
File Change
docs.json Changed · +1 −0

Updated 2026-09-08 19:18:12 UTC for deployment · 3c3f626.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Preview: https://wb-21fd5541-update-reference-docs-60.mintlify.site

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor Author

Readability impact

Word-weighted Flesch-Kincaid grade change across 9 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/python-sdk.mdx 8.4 8.3 -0.1 +0.3 easier
weave/reference/python-sdk/trace/feedback.mdx 8.7 8.3 -0.4 +3.8 easier
weave/reference/python-sdk/trace/op.mdx 6.6 6.6 +0.0 +0.0 unchanged
weave/reference/python-sdk/trace/util.mdx 7.5 7.5 +0.0 +0.0 unchanged
weave/reference/python-sdk/trace/weave_client.mdx 6.5 6.6 +0.1 -0.4 harder
weave/reference/python-sdk/trace_server/trace_server_interface.mdx 11.3 11.4 +0.1 -0.4 harder
weave/reference/python-sdk/trace_server_bindings/remote_http_trace_server.mdx 8.5 8.5 +0.0 +0.0 unchanged
weave/reference/service-api.mdx 169.9 171.4 +1.5 -4.2 harder
weave/reference/typescript-sdk.mdx 53.7 54.0 +0.3 +0.0 harder
weave/reference/typescript-sdk/type-aliases/session-1.mdx too little prose to score

AI agent comprehension

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

Page Before After Δ
weave/reference/python-sdk.mdx 3 2 -1
weave/reference/python-sdk/trace_server/trace_server_interface.mdx 3 3 +0
weave/reference/python-sdk/trace/weave_client.mdx 2 2 +0
weave/reference/service-api.mdx 3 3 +0
weave/reference/python-sdk/trace/util.mdx 3 3 +0
weave/reference/python-sdk/trace/op.mdx 2 2 +0
weave/reference/python-sdk/trace_server_bindings/remote_http_trace_server.mdx 2 2 +0
weave/reference/python-sdk/trace/feedback.mdx 3 3 +0
weave/reference/typescript-sdk.mdx 3 3 +0

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

From workflow run 34268019609

@dbrian57 dbrian57 closed this Sep 8, 2026
@dbrian57

dbrian57 commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

PR is too old and predates the redesign.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated documentation Improvements or additions to documentation weave

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants