mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
3d06e5e381
## Summary Rebuilds the project README from scratch for the Stack Auth → Hexclave rebrand. The previous README was out of date. The README rewrite also surfaced a few stale Stack-Auth references in adjacent docs, which are fixed in the same PR. ### README New structure: - **Top section**: name, "The user infrastructure platform" tagline, intro paragraph, links, and badges - **Get started**: a single AI-agent setup prompt (`Read skill.hexclave.com and help me setup hexclave in this project`) - **What's included**: a catalog of the non-alpha apps (Authentication, Teams, RBAC, API Keys, Payments, Emails, Analytics, Webhooks, Data Vault, Launch Checklist), each with a logo, blurb, and screenshot - **Contributing**: pointer to `CONTRIBUTING.md`, Discord, and the security contact - **Contributors**: restored at the bottom, now pointing at the correct `hexclave/stack-auth` repo on contrib.rocks Note: an explicit **SDKs** section was intentionally dropped for now — the `@hexclave/next`, `@hexclave/react`, `@hexclave/js` packages aren't yet published under that scope, and surfacing install instructions for unpublished packages would just confuse landing users. The badges in the header still call out the supported SDKs, and the setup prompt routes users to docs. We'll add a dedicated SDKs section once the packages exist. ### CONTRIBUTING.md & SECURITY.md Both still referenced Stack Auth after the README rewrite. Updated: - `CONTRIBUTING.md`: "Stack Auth" → "Hexclave", `discord.stack-auth.com` → `discord.hexclave.com`, `docs.stack-auth.com` → `docs.hexclave.com`, `security@stack-auth.com` → `security@hexclave.com` - `.github/SECURITY.md`: "Stack Auth" → "Hexclave", `team@stack-auth.com` → `team@hexclave.com`, `security@stack-auth.com` → `security@hexclave.com` This keeps the disclosure flow consistent across the three docs. ### Markdown lint / a11y polish - Added a `text` language tag to the bare fenced block under "Get started" (markdownlint MD040) - Added `alt=""` to the 10 inline heading logos (markdownlint MD045) — empty alt is correct here because the heading text immediately to the right already names the section, so the logo is decorative ## Open items A few rebrand details still need confirmation; this PR assumes them and uses them in copy: - Domains assumed: `hexclave.com`, `docs.hexclave.com`, `app.hexclave.com`, `discord.hexclave.com`, `security@hexclave.com`, `team@hexclave.com`. Only `skill.hexclave.com` is confirmed. - The `skill.hexclave.com` setup-prompt page needs to exist for the Get started flow to work. - License and Self-hosting sections were intentionally omitted; the header badges were kept. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Rebranded the project from "Stack Auth" to "Hexclave" with a new streamlined README, hero section, and updated feature catalog * Updated contribution guide with Hexclave-specific links, added Discord coordination before starting work, and adjusted setup instructions * Updated security policy and contact emails for vulnerability reporting and consulting * Refined table-of-contents workflow to target the contributing guide only <!-- review_stack_entry_start --> [](https://app.coderabbit.ai/change-stack/hexclave/stack-auth/pull/1474?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: BilalG1 <BilalG1@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| app-shots | ||
| logos | ||
| account-settings.png | ||
| comparison.png | ||
| components.png | ||
| connected-accounts.png | ||
| create-project.gif | ||
| dark-light-mode.png | ||
| dashboard.png | ||
| email-editor.png | ||
| hexclave-header.svg | ||
| hexclave-rebrand-modal.png | ||
| impersonate.png | ||
| logo.png | ||
| m2m-auth.png | ||
| oauth-refresh.png | ||
| passkeys.png | ||
| permissions.png | ||
| sign-in.png | ||
| stack-webhooks.png | ||
| team-switcher.png | ||
| user-button.png | ||
