Skip to content

Writing about Alpha and Beta products

Devon edited this page Dec 30, 2024 · 1 revision

When documenting products that are in Alpha or Beta status, it's important to clearly and consistently communicate their development progress. Follow the below best practices to set expectations for users interested in developing with SignalWire products in Alpha or Beta status.

Definitions

Status Definition Support and feedback
Alpha Ready to test, but feature incomplete Users are treated as early access customers - their feedback is prioritized
Beta Ready to test, and feature complete Beta customers will be prioritized for support when reporting bugs

Both Alpha and Beta releases are expected to have known and unknown bugs which will be addressed promptly as they are identified and sized for remediation.

Article titles

Do not append development status ('Alpha' or 'Beta') to the text of the article title. Instead, append a badge component like so:

# Article Title

<AlphaBadge />

Or

# Article Title

<BetaBadge />

The result is a colorful badge that links to our documentation on Alpha and Beta releases.

Screenshot 2024-05-22 at 1 03 19 PM

In headings

When you want to create an Alpha or Beta badge within a Markdown heading, use the following syntax instead:

{<span className="badge badge--danger">ALPHA</span>}