Skip to content

Commit d481bee

Browse files
docs: add beta notice and STABILITY.md
Add beta banner to README and create STABILITY.md linking to the canonical component status table in dev-toolchain. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent f5bb67a commit d481bee

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# devrail.dev
22

3+
> **Beta** -- DevRail is under active development. Standards, tooling, and site content may change without notice. See [STABILITY.md](STABILITY.md) for details.
4+
35
The documentation site for [DevRail](https://devrail.dev) -- opinionated development standards for teams that ship with AI agents.
46

57
## Quick Start

STABILITY.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Stability
2+
3+
DevRail is in **beta** (`v0.x`). The project is under active development.
4+
5+
## What "Beta" Means
6+
7+
- **Standards may change.** Section content, naming, and structure may be revised as we learn from real-world usage.
8+
- **Tooling may change.** Tool versions, container contents, and Makefile targets may be updated without prior deprecation.
9+
- **No backward-compatibility guarantee.** Until `v1.0.0`, any release may include breaking changes. Pin to a specific tag if you need stability.
10+
- **Feedback is welcome.** File issues, open discussions, or submit PRs. Early adopters shape the final product.
11+
12+
## Component Status
13+
14+
For the full component-by-component status table, see the [dev-toolchain STABILITY.md](https://github.com/devrail-dev/dev-toolchain/blob/main/STABILITY.md).
15+
16+
## Versioning
17+
18+
All DevRail repos use `v0.x.y` during beta. The `0.x` range signals that breaking changes may occur in any release, per [Semantic Versioning](https://semver.org/) conventions.
19+
20+
Once the core standards, toolchain image, and CI templates are stable and validated in production use, we will release `v1.0.0` and commit to backward compatibility.
21+
22+
## How to Track Changes
23+
24+
- Watch the [CHANGELOG.md](CHANGELOG.md) in each repo for release-by-release details.
25+
- Breaking changes will be called out explicitly in changelog entries during beta.

0 commit comments

Comments
 (0)