Skip to content

docs: add note about version usage in installation#11631

Open
dsk-dev-ai wants to merge 3 commits intoappwrite:1.9.xfrom
dsk-dev-ai:docs-clean
Open

docs: add note about version usage in installation#11631
dsk-dev-ai wants to merge 3 commits intoappwrite:1.9.xfrom
dsk-dev-ai:docs-clean

Conversation

@dsk-dev-ai
Copy link
Copy Markdown

@dsk-dev-ai dsk-dev-ai commented Mar 24, 2026

What does this PR do?

Adds a note in the installation section explaining that users can replace the fixed Appwrite version with the latest stable version if needed.

Test Plan

  • Verified the note appears correctly below the Unix installation command in the README.
  • Checked formatting and readability in Markdown preview.

Related PRs and Issues

  • None

Checklist

  • Have you read the Contributing Guidelines on issues?
  • If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 24, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e527cba1-7852-49d7-98f6-31dc74671fda

📥 Commits

Reviewing files that changed from the base of the PR and between 806bf29 and 1bda459.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md
📝 Walkthrough

Walkthrough

Added a Markdown "Note" block to README.md after each Unix and Windows Docker docker run ... appwrite/appwrite:1.9.0 self-hosting command snippet, stating users may replace the pinned 1.9.0 tag with the latest stable Appwrite image via the releases/latest link and clarifying that pinned tags ensure reproducibility while updating provides access to newer features and fixes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding documentation about version usage in the installation section.
Description check ✅ Passed The description is directly related to the changeset, explaining what was added, testing performed, and following the contributor checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

dsk-dev-ai
dsk-dev-ai commented Mar 24, 2026
View reviewed changes
Copy link
Copy Markdown
Author

@dsk-dev-ai dsk-dev-ai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this PR do?

Adds a note in the installation section explaining that users can replace the fixed Appwrite version with the latest stable version if needed.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 24, 2026

Greptile Summary

This PR adds a single-line note below the Unix installation command in README.md, explaining that users may substitute 1.9.0 with the latest stable version of Appwrite. The intent is helpful, but the implementation has two gaps worth addressing before merging.

  • Incomplete coverage: The note is placed only under the ### Unix section. The ### Windows > CMD and ### Windows > PowerShell blocks use the same hard-coded 1.9.0 version and receive no equivalent note, leaving Windows users without the same guidance.
  • Missing version reference link: The note advises replacing the version but does not point users to where they can find the latest release (e.g., the GitHub releases page). Adding a hyperlink would make the note immediately actionable.

Confidence Score: 4/5

  • Safe to merge — documentation-only change with no functional impact, though the note should ideally be applied to all platform sections for consistency.
  • The change is a pure documentation addition that cannot break any functionality. The two style issues (incomplete platform coverage and missing link) are improvements rather than blockers, so the PR is close to merge-ready.
  • README.md — note should be extended to the Windows CMD and PowerShell sections and enhanced with a link to the latest release.

Important Files Changed

Filename Overview
README.md Adds a version-replacement note after the Unix installation block; note is not applied to the Windows CMD/PowerShell blocks and lacks a link to the latest release page.

Reviews (1): Last reviewed commit: "Merge branch '1.9.x' into docs-clean" | Re-trigger Greptile

greptile-apps[bot]
greptile-apps bot reviewed Mar 24, 2026
View reviewed changes
dsk-dev-ai
dsk-dev-ai commented Mar 24, 2026
View reviewed changes
Copy link
Copy Markdown
Author

@dsk-dev-ai dsk-dev-ai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review!

  • Added note to Windows CMD and PowerShell sections for consistency.
  • Included link to the latest Appwrite release.

Let me know if anything else is needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@dsk-dev-ai