-
Notifications
You must be signed in to change notification settings - Fork 74
Open
Labels
enhancementNew feature or requestNew feature or request
Description
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".
- Tags should be:
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request