Skip to content

Canonical Article Structure

This standard defines the quality bar for article objects consumed by Omnivoltaic sites from article-bff.

Required Fields

Canonical site-facing article objects should provide:

  • articleKey
  • slug
  • title
  • subtitle
  • body
  • heroImage
  • author
  • publishedAt

Content Rules

  • title should carry one clear claim or subject.
  • subtitle should clarify audience value or use case.
  • body should follow a stable heading hierarchy.
  • heroImage.alt should be descriptive and specific.

Recommended Body Flow

  1. Context
  2. Approach
  3. Technical or operational detail
  4. Business or user impact
  5. References

Taxonomy Rule

Only describe taxonomy or metadata that the live BFF contract actually supports for site use. Do not document local-only editorial fields as canonical article structure.

Identity Rule

  • the canonical slug is the slug returned by the BFF
  • public author display follows the current BFF-returned article shape
  • operational accountability belongs to BFF and downstream audit systems, not article page content metadata