[WBDOCS-828] Autogenerate Query Expression Language reference from weave-internal#2486
Merged
mdlinville merged 8 commits intomainfrom Apr 22, 2026
Merged
[WBDOCS-828] Autogenerate Query Expression Language reference from weave-internal#2486mdlinville merged 8 commits intomainfrom
mdlinville merged 8 commits intomainfrom
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links✨ Added (1 total)⚙️ Other (1)
📝 Changed (25 total)📄 Pages (25)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-wbdocs-828.mintlify.app |
- Add script to generate the query panel references from https://github.com/wandb/weave-internal/tree/master/weave-js - Add Github action to run the script on demand The action accesses the private repo using a fine-grained access token stored as a secret in the docs repo
domphan-wandb
approved these changes
Apr 21, 2026
domphan-wandb
left a comment
domphan-wandb
left a comment
There was a problem hiding this comment.
approving with minor comment.
the grammar is off due to the logic that uses an or a based on the leading vowel.
for example, "an user". maybe you could add a list of nouns that could override the behavior?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds an automated pipeline that regenerates English Query Expression Language (QEL) datatype reference pages under models/ref/query-panel/ from the same TypeScript source as the product: wandb/weave-internal (weave-js/), using upstream src/core/generateDocs.ts (run with vite-node after a yarn install --ignore-scripts).
This is query panel documentation, not the W&B Weave LLM product (/weave/).
Fixes WBDOCS-828
What changed
Why?
WBDOCS-828: QEL is defined in TypeScript; docs were previously maintained by hand and could drift (for example duplicate anchors in Chainable vs List sections). This ties public docs to the same generator path the internal repo uses, with Mintlify-specific post-processing.
How to test (reviewers)
Unit tests
From repo root:
python3 -m unittest discover -s scripts/reference-generation/query-panel/tests -p 'test_*.py' -vLocal full pipeline (recommended if you have weave-internal)
With an existing weave-js checkout:
export WEAVE_JS_ROOT=/path/to/weave-internal/weave-js ./scripts/reference-generation/query-panel/generate_query_panel_reference.shOr rely on clone + read token (same variable name as CI):
Then inspect git diff under models/ref/query-panel/, models/ref/query-panel.mdx, and docs.json.
Mintlify
mint broken-links,mint validate,mint devlocally. This PR's CI will also check these.GitHub Actions after this PR merges
Run workflow Generate Query Panel (QEL) reference on this branch. Confirm the job clones
weave-internal, completes generation and tests, and that a draft PR is created only when the working tree would change (or no PR if output matches main).Testing
mint dev)mint broken-links)