Skip to content

Implement Documentation Status Badges #14

@stkossman

Description

@stkossman

To improve documentation navigability and clearly communicate the state of our guides, we need to implement Starlight's built-in badge system.

Tasks:

  • Define standard badge usage in our CONTRIBUTING.md guidelines so all developers use the same terminology:
    • New (variant: success)
    • Updated (variant: note)
    • WIP (variant: caution)
    • Deprecated (variant: danger)
    • Advanced (variant: default)
  • Apply the New badge via frontmatter (sidebar.badge) to recently added pages (e.g., Database Schema, System Overview).
  • Utilize the inline <Badge /> component for specific advanced sections within articles (e.g., Redis Seat Locking).

Technical Example (Frontmatter):

sidebar:
  badge:
    text: New
    variant: success

Metadata

Metadata

Assignees

Labels

type: contentWriting new articles, guides, or updating text.type: ui/uxWork on components, Tailwind styles, changing the header/theme.
No fields configured for Feature.

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions