nebula-workbench-pages

Enforce placement of active Canvas Workbench pages in the top-level pages/ directory.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Enforces a repository-local convention that active Canvas Workbench pages must live in the top-level pages/ directory instead of examples/pages/, preventing accidental use of reference examples as canonical previews.

Core Features & Use Cases

  • Repository Policy Enforcement: Clarifies that examples/pages/ are reference-only and canonical Workbench pages belong in pages/.
  • Local Validation Guidance: Directs authors to use nebula-component-validation for repo-local static checks and to follow the canvas-page-definition contract.
  • Use Case: When migrating or creating Workbench previews, use this policy to ensure the repo's visual verification targets and CI checks operate on the intended pages/.

Quick Start

Create active Workbench pages in pages/ and run nebula-component-validation to perform local static validation.

Frequently Asked Questions about nebula-workbench-pages

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

FAQPage Schema
How do I enforce canonical Canvas Workbench pages in a repository?

To enforce canonical Canvas Workbench pages, place active previews in the top-level pages/ directory. This repository policy prevents the accidental use of examples/pages/ reference material as canonical Workbench previews during local validation.

Why should Workbench pages live in pages/ instead of examples/pages/?

Workbench pages should live in pages/ to separate canonical visual verification targets from reference material. The examples/pages/ directory is reference-only, ensuring repository workflows and CI checks operate on the intended active Canvas pages.

How do I validate Canvas Workbench pages locally in a Nebula repository?

To validate Canvas Workbench pages locally, create active previews in the pages/ directory and run nebula-component-validation. This performs repo-local static checks to ensure adherence to the canvas-page-definition contract.

Do I need a specific directory structure for Nebula Workbench page previews?

Yes, Nebula workflows require a specific directory structure for Workbench page previews. Active Canvas pages must reside in the top-level pages/ directory, while examples/pages/ is kept strictly as reference material.

What is the canvas-page-definition contract used for in Workbench page validation?

The canvas-page-definition contract defines the required structure for page previews. Authors must adhere to this contract when creating canonical Workbench pages in the pages/ directory to pass repo-local static validation checks.

Can I use examples/pages/ for active Canvas Workbench previews?

No, examples/pages/ is reference-only and cannot be used for active Canvas Workbench previews. The repository policy mandates that canonical Workbench previews must live in the top-level pages/ directory to prevent validation errors.