Skip to content

DOCS-1001: Add documentation for CustomChart API and query syntax #1641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOCS-1001: Add documentation for CustomChart API and query syntax #1641

wants to merge 1 commit into from

Conversation

johndmulhausen
Copy link
Contributor

@johndmulhausen johndmulhausen commented Sep 13, 2025 •
edited by github-actions bot
Loading

Overview

This PR adds comprehensive documentation for custom charts, including detailed query syntax examples and programmatic usage patterns.

Changes

  • Added CustomChart documentation in edit-a-report.md with examples of how to use wr.CustomChart to add custom visualizations to reports programmatically
  • Created a new query syntax guide (query-syntax.md) that explains:
    • Different data table types (summary, history, summaryTable, historyTable)
    • Query syntax patterns for each table type
    • Comprehensive examples of using CustomChart with the Reports API
    • Methods for importing existing charts to reports
    • Best practices and troubleshooting tips
  • Enhanced custom-charts index page with Reports API integration details and links to the new query syntax guide

Key Features Documented

  • How to query different W&B data tables (summary, history, custom tables)
  • Programmatic creation of custom charts using wr.CustomChart
  • Integration with the Reports API for automated report generation
  • Importing and reusing existing charts in new reports
  • Common query patterns and best practices

Testing

  • All code examples have been validated for correct syntax
  • Documentation follows existing W&B docs patterns and conventions
  • Internal links use Hugo's relref shortcode for proper cross-references

Resolves DOCS-1001

📄 View preview links for changed content

@johndmulhausen
Add documentation for CustomChart API and query syntax
06c4a28 
- Added comprehensive documentation for using wr.CustomChart in reports
- Created dedicated query syntax guide for custom charts
- Updated edit-a-report.md with CustomChart examples
- Enhanced custom-charts index with Reports API integration details
@johndmulhausen johndmulhausen requested a review from a team as a code owner September 13, 2025 20:10
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 13, 2025 •
edited
Loading

PR Preview: Changed content

Base preview: https://docs-1001.docodile.pages.dev

Added

Title Path
Query syntax for custom charts content/en/guides/models/app/features/custom-charts/query-syntax.md

Modified

Title Path
Edit a report content/en/guides/core/reports/edit-a-report.md
Custom charts content/en/guides/models/app/features/custom-charts/_index.md

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 06c4a28
Status: ✅  Deploy successful!
Preview URL: https://e98dc515.docodile.pages.dev
Branch Preview URL: https://docs-1001.docodile.pages.dev

View logs

johndmulhausen added a commit that referenced this pull request Sep 14, 2025
@johndmulhausen
Add redirect for app models guide to improve navigation (#1641)
3279800
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@johndmulhausen