Skip to content

Commit 78c035d

Browse files
authored
docs: Define feature maturity levels (#81)
1 parent c692672 commit 78c035d

File tree

3 files changed

+62
-9
lines changed

3 files changed

+62
-9
lines changed

docs.json

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -197,18 +197,13 @@
197197
},
198198
{
199199
"group": "User",
200-
"pages": [
201-
"references/user",
202-
"references/personal_tokens"
203-
]
200+
"pages": ["references/user", "references/personal_tokens"]
204201
},
205202
{
206203
"group": "Embedding",
207-
"pages": [
208-
"references/embedding",
209-
"references/react-sdk"
210-
]
211-
}
204+
"pages": ["references/embedding", "references/react-sdk"]
205+
},
206+
"references/feature-maturity-levels"
212207
]
213208
},
214209
{
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: "Feature Maturity Levels"
3+
description: "We use standardized maturity levels to help you understand the stability and availability of features as we develop them"
4+
sidebarTitle: "Feature Maturity Levels"
5+
---
6+
7+
## Feature lifecycle
8+
9+
```mermaid
10+
flowchart LR
11+
A(Experimental) --> B("Early Access")
12+
B --> C("Generally Available (GA)")
13+
14+
style A fill:#99F4D1,stroke:#99F4D1,color:#000
15+
style B fill:#D6C1FA,stroke:#D6C1FA,color:#000
16+
style C fill:#7262FF,stroke:#D6C1FA,color:#fff
17+
18+
linkStyle 0,1 stroke:#c0c0c0,stroke-with:1px
19+
```
20+
21+
### Experimental
22+
23+
Experimental features are where we explore new ideas and test out proof of concepts.
24+
25+
- We're still building out core functionality, so things may be incomplete or unstable
26+
- We might make breaking changes without much notice as we iterate
27+
- We limit access to our internal team and design partners
28+
- Our design partners help us figure out what the feature should do and how it should work
29+
- We're in full feedback-driven development mode
30+
31+
### Early Access
32+
33+
Early Access features are stable and work well, but we're still actively testing and improving them based on your feedback.
34+
35+
- Work smoothly with good performance
36+
- We might still make some changes based on what you tell us
37+
- We provide comprehensive documentation
38+
- Breaking changes are rare, and we'll always give you plenty of notice
39+
- Our support team is ready to help
40+
- We might put some usage limits in place while we fine-tune things
41+
- We're getting these features ready for our full GA release
42+
43+
### Generally Available (GA)
44+
45+
GA features are production-ready and fully supported by our team.
46+
47+
- We provide complete documentation and training materials
48+
- These features are stable with our commitment to backward compatibility
49+
50+
## Using Feature Maturity Levels
51+
52+
These levels help you understand what to expect from each feature's stability and performance, so you can decide what works best for your production environment and risk tolerance.
53+
54+
When you're evaluating features for your use case, we recommend considering the maturity level alongside your requirements for stability, support, and backward compatibility.

references/references.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,8 @@ mode: wide
4848
<Card title="SCIM Integration" href="/references/scim-integration" icon="file-lines" iconType="solid" horizontal>
4949
SCIM Integration is only available on...
5050
</Card>
51+
52+
<Card title="Feature Maturity Levels" href="/references/feature-maturity-levels" icon="file-lines" iconType="solid" horizontal>
53+
Standardized levels that communicate...
54+
</Card>
5155
</CardGroup>

0 commit comments

Comments
 (0)