Skip to content

[Feature]: Tagging Evergreen Docs #407

@dpshade

Description

@dpshade

Problem to solve

It can be difficult for users to distinguish between documentation pages that describe:

  • Rapidly evolving, cutting-edge technology (where details may soon change or become outdated), and
  • Stable, well-established technology ("evergreen" content) that remains reliable even after years without updates.

The lack of such clarity can erode user trust and discourage referencing the docs for critical, long-term projects.

Proposed solution

  • Introduce a tagging system for each documentation page that visually indicates its tech maturity or stability status.
  • Suggested tags:
    • Cutting Edge: Technology or APIs that are new, experimental, or subject to frequent change.
    • Stable: Functionality that is widely used, unlikely to change, but might see occasional updates.
    • Evergreen: Well-established core concepts or APIs that have remained unchanged for years and are expected to remain true for the foreseeable future.
  • Implementation details:
    • Tags should be:
      • Prominently displayed at the top of each doc page.
      • Maintained by repo contributors (possibly automated or semi-automated via metadata).
      • Linked to docs update/approval workflows, so that out-of-date pages can be easily reviewed or tagged as "expired".

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions