Updating readme with unsupported/depreciation notice #15
Conversation
|
""" WalkthroughThe README.md file was updated to display a clear deprecation notice at the top, stating the repository is unmaintained, unsupported, and not intended for production. Minor formatting adjustments were made throughout, including list style changes, improved spacing, and reformatting Go code examples for consistency. No code or usage instructions were changed. Changes
Poem
""" 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
Adds a prominent deprecation notice to the README, clarifying that the project is no longer supported and should not be used in production.
- Introduces a “Notice of Deprecation” section with warranty and liability disclaimers
- Wraps the notice in horizontal rules for visibility
- Reformats the features list, resulting in a duplicated list of items
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
7-13: Demote the “Notice of Deprecation” heading to avoid multiple H1s
# Notice of Deprecationcreates a second top-level heading, which fragments the document structure and hurts screen-reader navigation. Using an H2 keeps a single, clear entry point (# pika) while still giving the notice high prominence.-# Notice of Deprecation +## Notice of Deprecation
37-41: Fix heading-level jump flagged by MD001
### Simple connect and Get(and### AIP-160) jump straight from an H1 (# Example) to an H3, violating the “increment by one” rule and harming accessibility tooling.-### Simple connect and Get +## Simple connect and Get … -### AIP-160 +## AIP-160Also applies to: 66-68
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
39-39: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
|
LGTM |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
README.md (1)
29-33: Fix heading-level jump (###→##)
markdownlintrightly flags the jump from# Example(H1) to### Simple connect and Get(H3). Keep levels incremental for readability and automated TOC tools.-### Simple connect and Get +## Simple connect and Get
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
31-31: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🔇 Additional comments (2)
README.md (2)
5-17: Ensure LICENSE consistency with the new deprecation disclaimerThe expanded “Notice of Deprecation” introduces warranty & liability language that might overlap or conflict with whatever is in the project’s
LICENSEfile. Double-check that the wording in both places is aligned (or reference the licence explicitly) to avoid ambiguity for downstream consumers.
21-27: Feature list duplication removed – nice cleanup
The previous redundant bullet section is gone and a single, consistent-style is used. Looks good.
Summary by CodeRabbit