Skip to content

docs(upgrade): clarify release compatibility and bootstrap path - #2073

Merged
dnlrsls merged 1 commit into
mainfrom
docs/release-upgrade-compatibility
Oct 11, 2026
Merged

dnlrsls merged 1 commit into
mainfrom
docs/release-upgrade-compatibility

Conversation

@dnlrsls

@dnlrsls dnlrsls commented Oct 10, 2026

Copy link
Copy Markdown
Member

Linked issue

Closes #2010

PR type

  • Documentation only

Summary

  • State that upgrade is available on main from commit 96ff045, but not in published releases through v4.0.0.
  • Explain why older launchers open upgrade as a prompt and provide a fresh-main-checkout bootstrap procedure.
  • Keep Gentle Shell upgrade distinct from Pi package update, including the effect of returning to stable.

Changes

File Change
README.md Put release compatibility and the older-installation path before upgrade examples.
docs/readme-reference.md Document availability, bootstrap commands, channel choices and unattributed-installation limitations.

Test plan

  • git diff --check passed before committing.
  • Structurally read back the complete documentation diff and link targets.
  • Native assessment: passive, structural readback only, reviewDue false.
  • Runtime tests and installer execution: not applicable; documentation only, no runtime changes.

Contributor checklist

Scope

Only README.md and docs/readme-reference.md; rollback removes these documentation additions without changing runtime behavior.

@dnlrsls dnlrsls added the type:docs Documentation only label Oct 10, 2026
@coderabbitai

coderabbitai Bot commented Oct 10, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 20 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: b40c286b-91e2-4fd2-97c8-c5167242bae9

📥 Commits

Reviewing files that changed from the base of the PR and between a6c539a and 9192898.


📒 Files selected for processing (2)
  • README.md
  • docs/readme-reference.md

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@dnlrsls
dnlrsls merged commit 227a9d9 into main Oct 11, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(docs): documented upgrade command opens a prompt on Gentle Shell 1.1.0

1 participant