Skip to content

Added new client notice#672

Open
1enify wants to merge 1 commit into
Nerimity:mainfrom
1enify:patch-1
Open

Added new client notice#672
1enify wants to merge 1 commit into
Nerimity:mainfrom
1enify:patch-1

Conversation

@1enify

@1enify 1enify commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

  • Adds new client notice

Checklist

  • Changes are clear, concise, and easy to review
  • Code has been tested and works as intended
  • Text/content changes support internationalization (i18n)
  • Any new user-facing strings are properly localized

Summary by CodeRabbit

  • Documentation
    • Updated the deprecation notice in the README with a clearer warning heading, a link to the Vanilla client, and a note that major updates will no longer continue.
    • Adjusted minor formatting around the end of the Servers list and the start of the Explore section.

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The README's deprecation notice was converted into a heading that links to the Vanilla client and states that major updates will stop. Minor Markdown spacing adjustments were made near the boundary between the "Servers" list and the "Explore" section.

Changes

README Update

Layer / File(s) Summary
Deprecation notice and formatting adjustment
README.md
Deprecation notice changed to a "### ⚠️" heading linking to the Vanilla client with updated wording, plus minor spacing changes before the "Explore" section.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes the PR purpose and checklist, but it omits required sections like screenshots, testing details, and additional context. Add the missing template sections, especially Screenshots, Did you test your code?, and Additional context, and clarify any i18n/localization impact.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and matches the change: a new client notice in the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 18-19: The README uses a level-3 heading for the project status
notice, which breaks heading hierarchy and markdownlint heading-increment.
Update that notice in the README to a level-2 heading so it follows the existing
section structure consistently.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 958c3cb2-86c9-4328-9569-728946b25b1c

📥 Commits

Reviewing files that changed from the base of the PR and between 8753e44 and 41c3f6e.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
Comment on lines +18 to +19
### ⚠️ This project has ceased development in favor of [the Vanilla client](https://github.com/nerimity/nerimity-web-vanilla). It will still be supported, but will no longer receive any major updates.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use a level-2 heading here.

### skips ##, which triggers the markdownlint heading-increment rule and makes the README hierarchy inconsistent.

♻️ Proposed fix
-### ⚠️ This project has ceased development in favor of [the Vanilla client](https://github.com/nerimity/nerimity-web-vanilla). It will still be supported, but will no longer receive any major updates.
+## ⚠️ This project has ceased development in favor of [the Vanilla client](https://github.com/nerimity/nerimity-web-vanilla). It will still be supported, but will no longer receive any major updates.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### ⚠️ This project has ceased development in favor of [the Vanilla client](https://github.com/nerimity/nerimity-web-vanilla). It will still be supported, but will no longer receive any major updates.
## ⚠️ This project has ceased development in favor of [the Vanilla client](https://github.com/nerimity/nerimity-web-vanilla). It will still be supported, but will no longer receive any major updates.
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 18-18: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 18 - 19, The README uses a level-3 heading for the
project status notice, which breaks heading hierarchy and markdownlint
heading-increment. Update that notice in the README to a level-2 heading so it
follows the existing section structure consistently.

Source: Linters/SAST tools

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant