site-config-review

Review Stencila site configuration files for correctness, routes, layout, and deployment readiness.

902|58|Updated May 31, 2012
One-click install
npx skills add https://github.com/stencila/stencila --skill site-config-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: site-config-review
Source: https://github.com/stencila/stencila/tree/main/.stencila/skills/site-config-review
Command: npx skills add https://github.com/stencila/stencila --skill site-config-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Manually auditing a stencila.toml site configuration is error-prone: invalid routes, missing workspace dependencies, misconfigured layouts, and broken redirects can silently break a site before deployment. This Skill performs a structured, multi-dimensional review of an existing Stencila site configuration and reports prioritized findings.

Core Features & Use Cases

  • Structural and Route Validation: Checks TOML syntax, field types, enum values, file route existence, redirect targets, and spread route arguments against the Stencila schema.
  • Layout and Best-Practice Review: Evaluates layout presets, component references, override ordering, and common misconfigurations such as missing social links or shadowed glob overrides.
  • Visual Verification: Uses the snap tool on the /_specimen/ route to verify rendered layout, responsive behavior, dark mode, and color palettes when a server is running.
  • Use Case: Before deploying a documentation site, ask for a deployment-readiness review of stencila.toml and receive blocking, important, and optional findings with a final verdict.

Quick Start

Review my stencila.toml site configuration for deployment readiness and report any blocking issues.

Frequently Asked Questions about site-config-review

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

FAQPage Schema
How do I validate a stencila.toml site configuration?

Run stencila config check to validate the configuration against the schema, then stencila config show to inspect resolved values. This Skill automates that process and adds route, layout, and best-practice review on top.

How to check Stencila site routes and redirects before deployment?

Use stencila site list to see the resolved route table and stencila site list --expand to verify spread route expansion. The review confirms file routes exist relative to site.root and that redirects use internal targets with appropriate status codes.

Can this Skill create a new Stencila site configuration?

No, this is a review-only skill for assessing an existing stencila.toml or a proposed configuration change. If no config exists, it will ask whether you want help creating one instead.

Why do Stencila access restrictions not work on my site?

Non-public access levels, reviews, uploads, and custom domains all require workspace.id to be set, because they depend on Stencila Cloud. Without workspace.id, access restrictions will not be enforced.

What happens if the snap tool is unavailable during review?

Visual verification is marked as pending and the review lists the specific snap commands to run later, such as snapping the /_specimen/ route with screenshots, mobile devices, and dark mode. Findings are never fabricated without snap evidence.