SpecsModelExplore
Review Checklist for Specs
Review Checklist for Specs

Verify content, embeds, links, and metadata before publishing.

A short, repeatable checklist keeps specs accurate and readable. Run it before publishing or merging a spec change.

Content

  • The page has a single, clear purpose.
  • Intent and decisions are explained, not just described.
  • Headings and lists make it scannable.

Metadata

  • title and description are accurate and concise.
  • icon is set and appropriate.
  • Any label is correct and intentional.

Embeds

  • Model embeds use real props (model_key, workflow_id, object_id + artifact_key + type).
  • Embedded objects/workflows resolve (no unresolved references).
  • Artifacts point to current paths.
  • Internal links are relative and resolve.
  • The page is registered in its group meta.yaml.
  • Cross-links point to the right sections.

Rendering

  • Frontmatter is valid YAML and renders.
  • No unsupported syntax (indented code blocks, ~~~ fences, raw inline HTML).
  • Components render as intended in view mode.

Automate what you can (link checks, validation) and reserve human review for clarity and intent — the parts tools cannot judge.

Related references

For exact rules, see the Markdown reference and MDX Components reference.

Last updated on