From 36f1bf0adbd58ef2c393cbf05a65e9a4e1d0ca53 Mon Sep 17 00:00:00 2001 From: Jason Wen Date: Sun, 4 Aug 2024 23:37:24 -0400 Subject: [PATCH] definitions --- docs_sp/branches/definitions.md | 11 +++++++++++ mkdocs-sp.yml | 2 ++ 2 files changed, 13 insertions(+) create mode 100644 docs_sp/branches/definitions.md diff --git a/docs_sp/branches/definitions.md b/docs_sp/branches/definitions.md new file mode 100644 index 0000000000..3a72b981f4 --- /dev/null +++ b/docs_sp/branches/definitions.md @@ -0,0 +1,11 @@ +# **Definitions** + +| Branch | Definition | Description | Stability/Readiness | +|:------------:|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| +| `release-c3` | Release branch | Stable release branches. After testing on `staging-c3`, updates are pushed here and published publicly. | **Ready to Use:** Highly stable, recommended for most users. | +| `staging-c3` | Staging branch | Pre-release testing branches. Community feedback is essential to identify issues before public release. | **Varied Stability:** Generally stable, but intended for testing before public release. | +| `dev-c3` | Development branches | Experimental branches with the latest features and bug fixes brought in manually. Expect bugs and braking changes. | **Experimental:** Least stable, suitable for testers and developers. | +| `master` | Primary development branch | All Pull Requests are merged here for future releases. CI automatically strips, minifies, and pushes changes to `staging-c3`. Running the `master` branch is suitable for development purposes but not recommended for non-development use. | **For Development Use:** Suitable for developers, may be unstable for general use. | + +!!! note + Your feedback is invaluable. Testers, even without software development experience, are encourage to run `dev-c3` and report issues. diff --git a/mkdocs-sp.yml b/mkdocs-sp.yml index 0208fa37a8..79f9c9b0d6 100644 --- a/mkdocs-sp.yml +++ b/mkdocs-sp.yml @@ -80,6 +80,8 @@ nav: - installation/index.md - URL Method: installation/url-method.md - SSH Method: installation/ssh-method.md + - Branches: + - Definitions: branches/definitions.md - Features: - Modified Assistive Driving Safety (MADS): features/modified-assistive-driving-safety.md - Dynamic Lane Profile (DLP): features/dynamic-lane-profile.md