From 51665ce77d60fef4345295893c65f2da616e02e1 Mon Sep 17 00:00:00 2001
From: Mantra <87142457+mantrakp04@users.noreply.github.com>
Date: Thu, 18 Jun 2026 10:17:10 -0700
Subject: [PATCH] Add README files to all published @hexclave npm packages
 (#1608)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## Summary

Adds README files with links to hexclave.com and docs.hexclave.com to
all published @hexclave npm packages.

- Created new READMEs for `cli`, `dashboard-ui-components`, `sc`,
`shared`, `shared-backend`, `ui`
- Updated `packages/template/README.md` (source for generated packages:
`js`, `react`, `next`, `tanstack-start`)

Link to Devin session:
https://app.devin.ai/sessions/8d67d0953fd5443992e958fab75eb58f
Requested by: @mantrakp04

<!-- This is an auto-generated description by cubic. -->
---
## Summary by cubic
Added README files to all published `@hexclave` packages. Each package
README now points to the repo’s root `README.md` to centralize docs and
install steps.

- **New Features**
- Added single-line `README.md` linking to `../../README.md` for
`@hexclave/cli`, `@hexclave/dashboard-ui-components`, `@hexclave/sc`,
`@hexclave/shared`, `@hexclave/shared-backend`, `@hexclave/ui`.
- Replaced `packages/template/README.md` with a link to the root README,
removing the old rename/migration text.

<sup>Written for commit f9c3ff51e8b3306b9c4e2c47db3a6974e98a0e40.
Summary will update on new commits.</sup>

<a
href="https://cubic.dev/pr/hexclave/hexclave/pull/1608?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="Review in cubic"
src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a>

<!-- End of auto-generated description by cubic. -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Updated README handling for multiple SDK packages (CLI, UI components,
server components, shared utilities, UI, and template) by converting
their package README files into symbolic links to the root README.
* This centralizes documentation content, keeping package doc pages
consistent without maintaining duplicate, package-specific README text.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: mantra <mantra@stack-auth.com>
---
 packages/cli/README.md                     |  1 +
 packages/dashboard-ui-components/README.md |  1 +
 packages/sc/README.md                      |  1 +
 packages/shared-backend/README.md          |  1 +
 packages/shared/README.md                  |  1 +
 packages/template/README.md                | 11 +----------
 packages/ui/README.md                      |  1 +
 7 files changed, 7 insertions(+), 10 deletions(-)
 create mode 120000 packages/cli/README.md
 create mode 120000 packages/dashboard-ui-components/README.md
 create mode 120000 packages/sc/README.md
 create mode 120000 packages/shared-backend/README.md
 create mode 120000 packages/shared/README.md
 mode change 100644 => 120000 packages/template/README.md
 create mode 120000 packages/ui/README.md

diff --git a/packages/cli/README.md b/packages/cli/README.md
new file mode 120000
index 000000000..fe8400541
--- /dev/null
+++ b/packages/cli/README.md
@@ -0,0 +1 @@
+../../README.md
\ No newline at end of file
diff --git a/packages/dashboard-ui-components/README.md b/packages/dashboard-ui-components/README.md
new file mode 120000
index 000000000..fe8400541
--- /dev/null
+++ b/packages/dashboard-ui-components/README.md
@@ -0,0 +1 @@
+../../README.md
\ No newline at end of file
diff --git a/packages/sc/README.md b/packages/sc/README.md
new file mode 120000
index 000000000..fe8400541
--- /dev/null
+++ b/packages/sc/README.md
@@ -0,0 +1 @@
+../../README.md
\ No newline at end of file
diff --git a/packages/shared-backend/README.md b/packages/shared-backend/README.md
new file mode 120000
index 000000000..fe8400541
--- /dev/null
+++ b/packages/shared-backend/README.md
@@ -0,0 +1 @@
+../../README.md
\ No newline at end of file
diff --git a/packages/shared/README.md b/packages/shared/README.md
new file mode 120000
index 000000000..fe8400541
--- /dev/null
+++ b/packages/shared/README.md
@@ -0,0 +1 @@
+../../README.md
\ No newline at end of file
diff --git a/packages/template/README.md b/packages/template/README.md
deleted file mode 100644
index ea4bca373..000000000
--- a/packages/template/README.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# This package has been renamed.
-
-Stack Auth is now Hexclave! The new packages are:
-
-- @hexclave/next
-- @hexclave/react
-- @hexclave/js
-- @hexclave/cli
-
-See the [migration guide](https://docs.hexclave.com/migration) for more information.
diff --git a/packages/template/README.md b/packages/template/README.md
new file mode 120000
index 000000000..fe8400541
--- /dev/null
+++ b/packages/template/README.md
@@ -0,0 +1 @@
+../../README.md
\ No newline at end of file
diff --git a/packages/ui/README.md b/packages/ui/README.md
new file mode 120000
index 000000000..fe8400541
--- /dev/null
+++ b/packages/ui/README.md
@@ -0,0 +1 @@
+../../README.md
\ No newline at end of file