docs: add experimental software disclaimer

[daviddao]

Summary

Adds a prominent disclaimer across the SDK that this is experimental software and should not be used in production.

Changes

• Root README.md — Added warning banner at the top
• sdk-core README.md — Added warning banner at the top
• sdk-react README.md — Added warning banner at the top
• SDK runtime — Added console.warn() on SDK instantiation so developers see the warning at runtime

Disclaimer text

⚠️ Experimental Software — Not for Production Use

This SDK is experimental and under active development. It should not be used in production environments. For production use, please use the ATProto SDK directly and the scaffold app as a reference implementation.

Testing

• ✅ Build passes (pnpm build)
• ✅ All sdk-core tests pass (790/790)
• ✅ Lint passes (pnpm lint)
• ⚠️ Pre-existing sdk-react test failures (unrelated localStorage.clear issue)

Summary by CodeRabbit

• Documentation
  • Added experimental software warnings across package documentation and SDK initialization, advising against production use.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 01a70c1

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]

📝 Walkthrough

Walkthrough

Added experimental-use warnings and disclaimers across project documentation and SDK initialization. Console warning messages direct users away from production use and reference alternative SDKs and resources. No functional logic changes introduced.

Changes

Cohort / File(s)	Summary
Documentation Warnings README.md, packages/sdk-core/README.md, packages/sdk-react/README.md	Added prominent experimental-use disclaimers at the top of README files warning against production use and directing users to ATProto SDK and scaffold app alternatives.
SDK Initialization Warning packages/sdk-core/src/core/SDK.ts	Added console.warn message in ATProtoSDK constructor to log experimental software notice and production alternatives after OAuth client initialization.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• Kzoeps
• aspiers

Poem

🐰 Hop hop, warnings we bring,
Experimental disclaimers take wing,
"Use with caution!" we proclaim,
Production-ready? Not our fame! 🚀⚠️

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: add experimental software disclaimer' accurately and clearly summarizes the main change across the pull request, which is adding experimental software disclaimers to multiple README files and SDK runtime warnings.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/experimental-disclaimer

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

packages/sdk-core/src/core/SDK.ts (1)

178-183: Route the experimental warning through the SDK logger first.

Line 179 logs directly with console.warn, which bypasses the configured logger and makes warning handling less controllable for integrators. Prefer this.logger?.warn with a console fallback.

🔧 Proposed refactor

-    // Experimental software warning
-    console.warn(
-      "[`@hypercerts-org/sdk-core`] ⚠️ This SDK is experimental and should not be used in production. " +
-        "For production use, please use the ATProto SDK (https://github.com/bluesky-social/atproto) " +
-        "and the scaffold app (https://github.com/hypercerts-org/hypercerts-app).",
-    );
+    // Experimental software warning
+    const EXPERIMENTAL_WARNING =
+      "[`@hypercerts-org/sdk-core`] ⚠️ This SDK is experimental and should not be used in production. " +
+      "For production use, please use the ATProto SDK (https://github.com/bluesky-social/atproto) " +
+      "and the scaffold app (https://github.com/hypercerts-org/hypercerts-app).";
+    if (this.logger?.warn) {
+      this.logger.warn(EXPERIMENTAL_WARNING);
+    } else {
+      console.warn(EXPERIMENTAL_WARNING);
+    }

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@packages/sdk-core/src/core/SDK.ts` around lines 178 - 183, Replace the direct
console.warn call in the experimental software warning block with the SDK's
logger: call this.logger?.warn(message) and, if this.logger is undefined, fall
back to console.warn(message); ensure you use the exact same warning text and
locate the change in the experimental software warning section inside the SDK
class (the block currently using console.warn in SDK.ts) so the message is
routed through the SDK logger first.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@packages/sdk-core/src/core/SDK.ts`:
- Around line 178-183: Replace the direct console.warn call in the experimental
software warning block with the SDK's logger: call this.logger?.warn(message)
and, if this.logger is undefined, fall back to console.warn(message); ensure you
use the exact same warning text and locate the change in the experimental
software warning section inside the SDK class (the block currently using
console.warn in SDK.ts) so the message is routed through the SDK logger first.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 21d4137e-47a2-4cf1-9d90-3a4b15c983ef

📥 Commits

Reviewing files that changed from the base of the PR and between 877d12c and 01a70c1.

📒 Files selected for processing (4)

• README.md
• packages/sdk-core/README.md
• packages/sdk-core/src/core/SDK.ts
• packages/sdk-react/README.md