Adjust changelog, update docs

abhinav · Dec 20, 2024 · 10935df · 10935df
1 parent a84f7a6
commit 10935df
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/.changes/unreleased/Added-20241201-205446.yaml b/.changes/unreleased/Added-20241201-205446.yaml
@@ -1,3 +1,5 @@
 kind: Added
-body: Add merged PRs to navigation comments
+body: >-
+  submit: Include merged changes in navigation comments
+  when restacking and resubmitting changes based on them.
 time: 2024-12-01T20:54:46.755566Z
diff --git a/doc/src/guide/cr.md b/doc/src/guide/cr.md
@@ -79,6 +79,16 @@ and the position of the current branch in it.
 This behavior may be changed with the $$spice.submit.navigationComment$$
 configuration key.
 
+
+!!! info "Stack history in navigation comments"
+
+    <!-- gs:version unreleased -->
+    When possible, git-spice will remember CRs as they're merged into trunk,
+    and continue to list them in navigation comments of branches
+    based on those changes.
+    However, it is unable to do this following complex stack manipulation
+    operations.
+
 ### Non-interactive submission
 
 Use the `--fill` flag (or `-c` since <!-- gs:version v0.3.0 -->)