Skip to content

Update README with support channel information#273

Closed
saleem2005-d wants to merge 1 commit intoopenwisp:masterfrom
saleem2005-d:master
Closed

Update README with support channel information#273
saleem2005-d wants to merge 1 commit intoopenwisp:masterfrom
saleem2005-d:master

Conversation

@saleem2005-d
Copy link
Copy Markdown

Added a note about support channels in README.

Added a note about support channels in README.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 7, 2026

📝 Walkthrough

Walkthrough

This change adds a minor HTML comment (<!-- minor improvement -->) and an extra blank line to the README.rst file, positioned near the end of the "Need help?" section. No functional content, documentation instructions, or structural elements are modified. The alteration is purely additive with no content removals.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title does not follow the required format [type] Descriptive title and lacks the mandatory type prefix (fix, change, feature, qa, ci, chores, or docs). Reformat the title to follow the required format, such as: [docs] Update README with support channel information
✅ Passed checks (2 passed)
Check name Status Explanation
Description check ✅ Passed The description is related to the changeset and mentions adding a note about support channels, which aligns with the README modifications shown in the summary.
Bug Fixes ✅ Passed The custom check for bug fixes does not apply to this pull request. The PR is a documentation enhancement to the README file, not a bug fix for core user-facing functionality.

✏️ 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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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 the current code and only fix it if needed.

Inline comments:
In `@README.rst`:
- Around line 188-189: Remove the HTML comment token ("<!-- ... -->") present in
README.rst which breaks RST parsing; either delete that line entirely or convert
it to a proper reStructuredText comment (use the RST comment marker and spacing)
and ensure surrounding list items retain correct blank-line termination so the
list parses correctly.
🪄 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: e7135bef-c56a-44cc-b32f-b13a84b6cb79

📥 Commits

Reviewing files that changed from the base of the PR and between 093bd99 and a4e7faf.

📒 Files selected for processing (1)
  • README.rst
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Kilo Code Review
🧰 Additional context used
🪛 GitHub Actions: OpenWISP Docs
README.rst

[error] 187-187: ReStructuredText check failed. Bullet list ends without a blank line; unexpected unindent.


[error] 187-187: Prettier/ReStructuredText formatting step failed for '/home/runner/work/openwisp-docs/openwisp-docs/README.rst'.

Comment thread README.rst
Comment on lines +188 to +189
<!-- minor improvement -->

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Remove HTML comment; it breaks RST parsing and CI.

Line 188 uses HTML comment syntax (<!-- ... -->) inside an .rst file, which causes the list/parser error reported by CI. Remove this line (or replace with valid RST comment syntax) and keep proper list termination spacing.

Suggested fix
 -<!-- minor improvement -->
 -

If you need a comment here, use RST form instead:

+..
+   minor improvement
+
📝 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
<!-- minor improvement -->
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.rst` around lines 188 - 189, Remove the HTML comment token ("<!-- ...
-->") present in README.rst which breaks RST parsing; either delete that line
entirely or convert it to a proper reStructuredText comment (use the RST comment
marker and spacing) and ensure surrounding list items retain correct blank-line
termination so the list parses correctly.

@nemesifier
Copy link
Copy Markdown
Member

Looks like spam.

@nemesifier nemesifier closed this Apr 7, 2026
@openwisp openwisp locked as spam and limited conversation to collaborators Apr 7, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants