Skip to content

docs: improve views documentation - HTTP queries and templating#470

Open
adityathebe wants to merge 6 commits intomainfrom
docs/view-documentation-improvements
Open

docs: improve views documentation - HTTP queries and templating#470
adityathebe wants to merge 6 commits intomainfrom
docs/view-documentation-improvements

Conversation

@adityathebe
Copy link
Member

@adityathebe adityathebe commented Feb 4, 2026

Improve views documentation:

HTTP Query docs:

  • Add Connection field section explaining hydration process
  • Add Templating support section with body examples
  • Add Response size limits section with property configuration
  • Import examples from fixtures using file= syntax

Templating docs:

  • Fix: values/valueFrom are required fields (not optional)
  • Separate values and valueFrom into distinct table rows
  • Add note admonition clarifying one is required

- Added mission-control/docs/guide/views/queries/http.md with usage guide and configuration details.
- Updated mission-control/docs/reference/views/_view.mdx to include http in the Query schema and reference section.
- Document display.table configuration in _view.mdx
- Add properties to panel types list in _view.mdx
- Create guide for properties panel
- Create guide for timeseries panel
- Create guide for decimal column type
- Format http.md (via make fmt)
- Guide: Add section on Default Sort and Page Size (display.table)
- Reference: Add validation requirement note for  in Prometheus/HTTP queries
- Add `ViewSection`, `ChangesUIFilters`, and `ConfigsUIFilters` schema tables
- Correct `ViewColumnDef` type enum by removing `url` and `badge` (they are properties)
- Add `badge` property to column definition
- Document `display.table` layout options
- Add `properties` panel type to panel definition
- Add `http` query and `columns` map to query definition
@vercel
Copy link

vercel bot commented Feb 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Error Error Feb 4, 2026 0:51am

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Feb 4, 2026

Caution

Review failed

The head commit changed during the review from 80c67da to 4950f63.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/view-documentation-improvements

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@netlify
Copy link

netlify bot commented Feb 4, 2026

Deploy Preview for canarychecker canceled.

Name Link
🔨 Latest commit 4950f63
🔍 Latest deploy log https://app.netlify.com/projects/canarychecker/deploys/6983409612de920007464d25

@adityathebe adityathebe force-pushed the docs/view-documentation-improvements branch from 80c67da to ca9cf9f Compare February 4, 2026 12:48
@adityathebe adityathebe changed the title docs: improve HTTP query documentation with fixtures docs: improve views documentation - HTTP queries and templating Feb 4, 2026
- Add Connection field section explaining hydration process
- Add Templating support section with body examples
- Add Response size limits section with property configuration
- Fix templating docs: values/valueFrom is required, not optional
- Import examples from fixtures using file= syntax
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant