doc/src/installation: note master branch follows rolling-release model #2116
Merged
0xda157 merged 1 commit intonix-community:masterfrom Jan 31, 2026
Merged
doc/src/installation: note master branch follows rolling-release model #21160xda157 merged 1 commit intonix-community:masterfrom
0xda157 merged 1 commit intonix-community:masterfrom
Conversation
trueNAHO
requested changes
Jan 5, 2026
Member
trueNAHO
left a comment
There was a problem hiding this comment.
What about this:
From b237060bae07d0e55ed0db5a37379ac48027ee3b Mon Sep 17 00:00:00 2001
From: NAHO <90870942+trueNAHO@users.noreply.github.com>
Date: Tue, 6 Jan 2026 00:16:58 +0100
Subject: [PATCH] doc/src/installation: note master branch follows
rolling-release model
Note that the master branch follows a rolling-release model, as version
mismatches are a common source of issues.
Link: https://github.com/nix-community/stylix/pull/2116
Co-authored-by: 0xda157 <da157@voidq.com>
---
doc/src/installation.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/doc/src/installation.md b/doc/src/installation.md
index d86b9171..1463f2e2 100644
--- a/doc/src/installation.md
+++ b/doc/src/installation.md
@@ -1,5 +1,15 @@
# Installation
+> [!IMPORTANT]
+> The master (unstable) branch of Stylix follows a rolling-release model. To
+> ensure compatibility, all inputs must be kept in sync.
+>
+> Avoid partial updates and always update inputs together with:
+>
+> ```console
+> nix flake update
+> ```
+
## NixOS
You can install Stylix into your NixOS configuration using [Flakes][nix-flakes].
--
2.51.2
This is what this looks like:
a19b7dc to
f3586ba
Compare
trueNAHO
requested changes
Jan 8, 2026
f3586ba to
4bebddb
Compare
trueNAHO
approved these changes
Jan 8, 2026
Member
There was a problem hiding this comment.
LGTM.
Since the rolling-release model applies to all branches, should we make it more generic:
> Stylix follows a rolling-release model. To ensure compatibility, all inputs > must be kept in sync.Also, we might want to add the word "version" in the second sentence:
> Stylix follows a rolling-release model. To ensure version compatibility, all > inputs must be kept in sync.
I rebased this PR on top of master and applied those changes. Feel free to merge this PR if those changes are fine with you.
0xda157
commented
Jan 8, 2026
Note that the master branch follows a rolling-release model, as version mismatches are a common source of issues. Link: nix-community#2116 Co-authored-by: 0xda157 <da157@voidq.com>
4bebddb to
f16fafa
Compare
trueNAHO
approved these changes
Jan 14, 2026
Member
trueNAHO
left a comment
There was a problem hiding this comment.
On a side note, it would be great to document our backport policy somewhere so it can be linked in the following:
stylix/.github/PULL_REQUEST_TEMPLATE.md
Line 16 in 3894cae
7 tasks
Contributor
|
Successfully created backport PR for |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
this has been a consistent issue people have been running into and reporting bugs about (e.g. #2114), so we should probably warn people in the documentation.