steedos-dashboards

Define Steedos dashboards from .dashboard.yml seed files with 18-column grid layouts.

1.6k|413|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-dashboards
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: steedos-dashboards
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-dashboards
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-dashboards

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Dashboards are defined as .dashboard.yml seed data files stored under <package>/main/default/dashboards/. Each file describes one dashboard: its cards (question references + grid positions) and optional filter parameters. In Steedos terms, this enables rapid, metadata-driven creation of analytics views without writing UI code.

仪表盘以 .dashboard.yml 种子数据文件形式存储,位于 <package>/main/default/dashboards/ 目录下。每个文件描述一个仪表盘及其卡片布局和可选的过滤参数,实现快速、基于元数据的分析视图创建。

Core Features & Use Cases

  • File location & naming: dashboards/<name>.dashboard.yml defines each dashboard.
  • Grid & cards: 18-column grid with card placements (row, col, size_x, size_y) and per-card settings.
  • Parameters & mappings: top-level parameters and per-card parameter_mappings link dashboards to questions.
  • Workflow: plan questions, layout, parameters, then write the dashboard seed file.

Quick Start

Create a dashboard seed file under <package>/main/default/dashboards that references existing questions and defines cards with their grid positions and optional parameters.

Frequently Asked Questions about steedos-dashboards

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I define Steedos dashboards using YAML seed data?

To define Steedos dashboards via YAML, create .dashboard.yml files under <package>/main/default/dashboards/. Each file specifies cards with question references, grid positions, and optional filter parameters for metadata-driven analytics views.

What is the grid layout structure for cards in a Steedos dashboard?

The Steedos dashboard grid layout uses an 18-column structure. Each card requires specific placements using row, col, size_x, and size_y properties to enforce strict positioning within the analytics view.

How do I pass filter parameters to questions on a Steedos dashboard?

You pass filter parameters by defining top-level parameters in the dashboard YAML file and linking them to specific questions using per-card parameter_mappings to control question inputs.

Can I reference existing questions when creating a dashboard YAML file?

Yes, dashboard YAML files reference existing questions. You plan questions, layout, and parameters first, then write the seed file to link cards to those questions with proper references and grid positions.

Why are my Steedos dashboard cards not displaying correctly?

Dashboard cards may fail due to missing strict field requirements, improper references between cards and questions, or incorrect grid placements violating the 18-column layout constraints enforced during YAML parsing.