Replace the Query Expression Language reference with new scripts/docs #1652
Conversation
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
- Reorganized query panel data types into dedicated subdirectory (data-types/) - Added new operations subdirectory for query panel operations - Migrated individual data type files from root query-panel/ to data-types/ - Updated media.md files across all language versions (en, ja, ko) - Added migration scripts for automated documentation updates - Added TypeDoc configuration and example files for documentation generation - Updated .gitignore to reflect new structure
johndmulhausen
changed the title
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
All alerts resolved. Learn more about Socket for GitHub. This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored. Ignoring alerts on:
|
johndmulhausen
changed the title
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Deploying docs with
|
| Latest commit: |
340564c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://83ae1560.docodile.pages.dev |
| Branch Preview URL: | https://query-panels.docodile.pages.dev |
|
PR Preview: Changed content Base preview: https://query-panels.docodile.pages.dev Added
Modified
Deleted
|
- Deleted obsolete scripts related to type structures, type linking, and data type fixes. - Removed outdated documentation files that no longer align with the current project structure. - Cleaned up the repository by eliminating unnecessary files to streamline future development.
…ion character escape Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
- Updated data types section with detailed descriptions for each type, including Run, Artifact, and new entries like ArtifactType and User. - Revised the operations description to clarify the functions available in the Query Expression Language. - Improved overall clarity and organization of the documentation for better user understanding.
|
@SocketSecurity ignore npm/[email protected] |
|
@SocketSecurity ignore npm/[email protected] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Overview
Overhauls the Query Expression Language docs in Reference.
Changes
Documentation Structure
/content/en/ref/query-panel/into a dedicated/content/en/ref/query-panel/data-types/subdirectory/content/en/ref/query-panel/operations/directory for query panel operations documentationData Type Cleanup - IMPORTANT
Removed non-queryable media types from Query Panel documentation
Justification for Deletions
After thorough validation against the W&B core source code, the following media/file types were removed from the Query Panel documentation:
Deleted Types:
object3D-file.mdmolecule-file.mdaudio-file.mdvideo-file.mdhtml-file.mdbokeh-file.mdimage-file.mdpytorch-model-file.mdWhy These Deletions Are Justified:
These types are NOT queryable: While these types ARE still fully supported in W&B for data logging and visualization (confirmed in
/scripts/core/frontends/weave/src/core/model/media/mediaTypes.ts), they are not queryable in the Query Expression Language. No query operations exist for these types in the ops directory.Display-only types: These are media/visualization types meant for rendering in the UI, not for data analysis or querying. The old documentation files only contained generic
asset-fileoperations with no specific query functionality.Avoiding user confusion: Including non-queryable media types in the Query Panel reference would mislead users into expecting query operations that don't exist.
Proper documentation scope: The Query Panel documentation should focus exclusively on types that can be meaningfully queried and manipulated:
Run,Artifact,Project,Entity,UserConfigDict,SummaryDict,TableMedia types belong elsewhere: Documentation for media logging (object3D, molecule, audio, video, etc.) belongs in the general SDK/logging documentation, not in the Query Expression Language reference.
Files Affected
Supporting Files
Benefits
Testing
Related Issues
Please link any related JIRA tickets or GitHub issues if applicable.
📄 View preview links for changed pages