[HYPER-260] add maintenance notice to README and AGENTS.md#142
[HYPER-260] add maintenance notice to README and AGENTS.md#142
Conversation
|
📝 WalkthroughWalkthroughThis PR updates documentation in AGENTS.md and README.md to reflect that the Hypercerts SDK is not currently maintained. Both files now display prominent warnings directing users to use the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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.
Pull request overview
This PR updates repository-facing documentation to clearly indicate the Hypercerts SDK is currently unmaintained, and to direct users (and AI agents) to alternative supported packages in the interim.
Changes:
- Replaces the top-level README “Experimental Software” banner with a stronger “Not Currently Maintained — Do Not Use” notice and updated guidance.
- Adds the same maintenance notice and alternative-package guidance to
AGENTS.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates the project status banner and recommends using @hypercerts-org/lexicon + the official AT Protocol SDK directly. |
| AGENTS.md | Adds the same maintenance notice so automated agents see the repository status immediately. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
c83a326 to
1b69912
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1b69912 to
0070556
Compare
0070556 to
baae80a
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
baae80a to
42aca06
Compare
|
@holkexyz @s-adamantine We could also temporarily archive although that might break users of the v0.1 SDK. |
I would be in favor of archiving it, BUT only if the people who have used it are aware of it and ok with it. |
Summary
@hypercerts-org/lexiconand the official AT Protocol SDK directly in the meantimeSummary by CodeRabbit
@hypercerts-org/lexiconnpm package alongside the official AT Protocol SDK