Update README with support channel information#273
Update README with support channel information#273saleem2005-d wants to merge 1 commit intoopenwisp:masterfrom
Conversation
Added a note about support channels in README.
📝 WalkthroughWalkthroughThis change adds a minor HTML comment ( Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 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'.
| <!-- minor improvement --> | ||
|
|
There was a problem hiding this comment.
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.
| <!-- 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.
|
Looks like spam. |
Added a note about support channels in README.