canvas-page-definition

Validate Canvas page JSON files against the Workbench schema contract.

16|6|Updated Feb 19, 2025
One-click install
npx skills add https://github.com/acquia/nebula --skill canvas-page-definition
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: canvas-page-definition
Source: https://github.com/acquia/nebula/tree/main/.agents/skills/canvas-page-definition
Command: npx skills add https://github.com/acquia/nebula --skill canvas-page-definition

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Canonical Canvas page specs are often inconsistent across authors and tools; this skill enforces a single, validated contract for page JSON files stored in the configured pagesDir, ensuring reliable previews and syncing with Canvas Workbench.

Core Features & Use Cases

It validates that a page JSON is a proper object with a non-empty title and an elements map where each element has a discovered component type; it applies to workflows from authoring to local previews in Workbench and to pushing/pulling pages with the Canvas CLI, enabling teams to ship consistent Canvas pages across projects.

Quick Start

Validate and align your local page specs with the canonical contract by ensuring your page JSON lives in the configured pagesDir and runs through the Canvas Workbench validation flow.

Frequently Asked Questions about canvas-page-definition

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

FAQPage Schema
How do I validate Canvas page JSON files for Workbench?

Page validation requires each page JSON to be a proper object with a non-empty title and an elements map where each element has a discovered component type. This skill enforces the contract for files in the configured pagesDir.

What is a Canvas page-spec contract and when do I need it?

A Canvas page-spec contract is a canonical validation rule for page JSON files ensuring consistent structure. You need it when authoring, previewing locally, or syncing pages with Canvas Workbench across multiple authors and tools.

Do I need a specific directory structure for Canvas Workbench page validation?

Yes, page validation requires placing your page JSON files in the configured pagesDir directory. The skill enforces the canonical contract specifically on files located in that directory to ensure reliable Workbench syncing.

Why does my Canvas page fail validation during Workbench sync?

Canvas page validation fails when the page JSON lacks a non-empty title, has no elements map, or contains elements missing a discovered component type. The skill enforces these requirements to satisfy the Canvas Workbench schema.

Can I use this page validation with the Canvas CLI for pushing and pulling pages?

Yes, this skill applies to workflows using the Canvas CLI for pushing and pulling pages. It ensures your local page specs align with the canonical contract before syncing with Workbench and Canvas.

What's the best way to keep Canvas page specs consistent across multiple authors?

The best way to keep Canvas page specs consistent is enforcing a single validated contract for page JSON files. This skill validates structure and component types in the configured pagesDir to ensure teams ship consistent Canvas pages.