Skip to content

[HYPER-260] add maintenance notice to README and AGENTS.md#142

Open
aspiers wants to merge 1 commit intodevelopfrom
readme-maintenance-notice
Open

[HYPER-260] add maintenance notice to README and AGENTS.md#142
aspiers wants to merge 1 commit intodevelopfrom
readme-maintenance-notice

Conversation

@aspiers
Copy link
Copy Markdown
Contributor

@aspiers aspiers commented Apr 4, 2026

Summary

  • Replaces the existing "Experimental Software" banner in README.md with a stronger "Not Currently Maintained — Do Not Use" notice
  • Adds the same maintenance notice to AGENTS.md so AI agents are aware of the project status
  • Recommends using @hypercerts-org/lexicon and the official AT Protocol SDK directly in the meantime

Summary by CodeRabbit

  • Documentation
    • Updated status notices across project documentation to indicate the SDK is no longer maintained
    • Added guidance to use @hypercerts-org/lexicon npm package alongside the official AT Protocol SDK

Copilot AI review requested due to automatic review settings April 4, 2026 00:44
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 4, 2026

⚠️ No Changeset found

Latest commit: 42aca06

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 4, 2026

📝 Walkthrough

Walkthrough

This 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 @hypercerts-org/lexicon npm package directly with the AT Protocol SDK instead.

Changes

Cohort / File(s) Summary
Maintenance Status Documentation
AGENTS.md, README.md
Added prominent blockquote and warning headers indicating the SDK is "Not Currently Maintained" and recommending users utilize @hypercerts-org/lexicon npm package directly alongside the official AT Protocol SDK. Updated status language from "Experimental Software" to reflect current non-maintained state.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The maintenance rest, a pause divine,
Our SDK steps back from the line,
Dear users, seek the lexicon way,
With AT Protocol—your trusted stray,
We'll hop back soon, but not today!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately reflects the main change: adding maintenance notices to both README and AGENTS.md files as documented in the changeset.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-maintenance-notice

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
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@aspiers aspiers force-pushed the readme-maintenance-notice branch 2 times, most recently from c83a326 to 1b69912 Compare April 4, 2026 00:51
Copilot AI review requested due to automatic review settings April 4, 2026 00:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@aspiers aspiers force-pushed the readme-maintenance-notice branch from 1b69912 to 0070556 Compare April 4, 2026 00:53
Copilot AI review requested due to automatic review settings April 4, 2026 00:55
@aspiers aspiers force-pushed the readme-maintenance-notice branch from 0070556 to baae80a Compare April 4, 2026 00:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@aspiers aspiers force-pushed the readme-maintenance-notice branch from baae80a to 42aca06 Compare April 4, 2026 01:07
@aspiers aspiers requested review from holkexyz and s-adamantine April 4, 2026 01:09
@aspiers
Copy link
Copy Markdown
Contributor Author

aspiers commented Apr 4, 2026

@holkexyz @s-adamantine We could also temporarily archive although that might break users of the v0.1 SDK.

@aspiers aspiers changed the title docs: add maintenance notice to README and AGENTS.md [HYPER-260] add maintenance notice to README and AGENTS.md Apr 4, 2026
@holkexyz
Copy link
Copy Markdown
Member

holkexyz commented Apr 4, 2026

@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.

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.

3 participants