Rebuild README.md for the Hexclave rebrand#1474
Draft
BilalG1 wants to merge 16 commits into
Draft
Conversation
Rewrite the README around the new Hexclave name with a revised intro, an AI-agent setup flow, the apps catalog, an SDK table, and a contributing section. Fix a stale anchor in CONTRIBUTING.md that pointed to a README section removed in the rewrite.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📝 WalkthroughWalkthroughThis PR rebrands repository content from Stack Auth to Hexclave, replaces the README with a Hexclave landing-page and app catalog, updates CONTRIBUTING.md with Hexclave links and a Discord coordination step, narrows the TOC workflow to only process CONTRIBUTING.md, and updates SECURITY.md contacts to Hexclave. ChangesDocumentation Rebranding and Contribution Flow
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
Embed the Hexclave header SVG at the top of the README. Replace the "What's included" table with a per-app pattern: logo, app name, description, and dashboard screenshot. Remove the SDKs section. New assets in .github/assets/: hexclave-header.svg, 10 app logos cropped from the dashboard apps catalog, and dashboard screenshots for Analytics and Launch Checklist. The existing storeDesc-*.png files in apps/dashboard/public/ are reused for the other 8 apps.
…stack-auth into cl/brave-keller-9ac5a8
Remove the doctoc-generated TOC at the top of the README since it sat above the centered header and contained stale entries. Embed the Jersey 10 web font directly into hexclave-header.svg as a base64 data-URI so the wordmark matches the landing page when rendered standalone. In "What's included", drop the per-app dashboard screenshots and extend each app's one-liner into 1-2 sentences pitching its specific features. Copy adapted from the per-app pages on the hexclave landing site. Delete the now-unused screenshot files from .github/assets/screenshots/.
- Drop the doctoc-generated TOC from README.md. It sat above the centered header and contained stale entries after the rewrite. - Exclude README*.md from the table-of-contents.yaml workflow so the bot stops re-adding the TOC on every push. CONTRIBUTING.md still gets its TOC generated. - Embed the Jersey 10 web font into hexclave-header.svg as a base64 data-URI so the wordmark matches the landing page when rendered standalone. - In "What's included", drop the per-app dashboard screenshots and extend each app's one-liner into 1-2 sentences pitching its features. Copy adapted from the per-app pages on the hexclave landing site. - Delete now-unused screenshot files from .github/assets/screenshots/.
- Replace "and many more features, so you don't have to build it yourself" with the tighter "and much more" in the intro paragraph. - Tighten the hexclave-header.svg viewBox from 200x48 to 162x48 so it fits the actual content. The old viewBox left ~22% empty space on the right, which made the centered logo appear shifted left on GitHub. - Drop "Python" from the SDKs badge. Hexclave does not ship a Python SDK; the JS SDK and REST API cover that use case.
Replace the old README with the README-1 experiment (full image-based 'What's included' section) and add a comparison chart above the Get started section. The chart shows where Hexclave sits on the dev infrastructure stack (Auth -> Analytics) relative to Vercel, Convex, Supabase, and Cloudflare.
The original README ended with a '❤ Contributors' section that rendered the contributor avatar grid via contrib.rocks. The rewrite dropped it; this puts it back, unchanged, at the very bottom after Contributing.
Contributor
Greptile SummaryThis PR replaces the Stack Auth README with a new Hexclave-branded document (feature catalog, AI-agent setup prompt, updated links and badges) and removes README.md from the automated TOC generator. It also patches one broken anchor in
Confidence Score: 3/5The README rewrite itself is clean, but two files carry live broken references that will mislead contributors and security reporters before this is merged. The contributors image will silently pull from the wrong GitHub repository, and CONTRIBUTING.md still routes Discord, docs, and security emails to the old Stack Auth domains — including the security contact, which could cause real security reports to be missed. These are not theoretical risks; the wrong links are present in the diff as-is. README.md (contributors image URL) and CONTRIBUTING.md (title, Discord, docs, and security email still reference Stack Auth). Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Visitor opens README.md] --> B{Section}
B --> C[Get started]
B --> D[What's included]
B --> E[Contributing]
B --> F[❤ Contributors]
C --> C1["Paste prompt into coding agent\n(tries try.hexclave.com — unconfirmed)"]
D --> D1[Feature catalog\nAuthentication · Teams · RBAC\nAPI Keys · Payments · Emails\nAnalytics · Webhooks · Data Vault\nLaunch Checklist]
E --> E2["Links to CONTRIBUTING.md\n(still has old Stack Auth branding)"]
F --> F1["contrib.rocks image\n⚠ points to stack-auth/stack\nnot hexclave/stack-auth"]
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
179-180:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix contributors image repository mismatch.
The anchor and image point to different repos, so the displayed contributor grid is likely incorrect.
Proposed fix
- <img src="https://contrib.rocks/image?repo=stack-auth/stack&columns=9" width="100%" /> + <img src="https://contrib.rocks/image?repo=hexclave/stack-auth&columns=9" width="100%" />🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 179 - 180, The contributors anchor and image reference different repos, causing the wrong contributor grid to display; update the two attributes so they point to the same repo (make the contrib.rocks ?repo= value match the anchor href repo). Specifically, edit the anchor href and/or the img src query param so both reference the same repository identifier (e.g., change the img src repo=... or the anchor href to use "hexclave/stack-auth" or whichever canonical repo name you want) so the contributor image matches the linked contributors page.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 43: The inline heading images in README.md (e.g., the heading containing
"### <img src=\".github/assets/logos/authentication.png\" .../>
Authentication") are missing alt attributes; update each heading image tag to
include a descriptive alt attribute (for example alt="Authentication logo" or
alt="Authentication") so they satisfy MD045 and improve accessibility, and apply
the same change to the other similar headings referenced (lines for the logos at
the listed occurrences).
- Around line 31-33: The fenced code block in README.md is missing a language
specifier (triggering markdownlint MD040); update the block around the line
containing "Read try.hexclave.com and help me setup hexclave in this project" to
include a language token (e.g., "text" or "markdown") after the opening triple
backticks so the block becomes ```text ... ``` and the linter passes.
- Line 13: Replace outdated security contact "security@stack-auth.com" with the
canonical "security@hexclave.com" across repository security docs; update
.github/SECURITY.md and CONTRIBUTING.md (and any other files containing the old
address) so the disclosure flow matches README.md, ensuring the security contact
lines and any example report templates or headers reference
security@hexclave.com exactly.
---
Outside diff comments:
In `@README.md`:
- Around line 179-180: The contributors anchor and image reference different
repos, causing the wrong contributor grid to display; update the two attributes
so they point to the same repo (make the contrib.rocks ?repo= value match the
anchor href repo). Specifically, edit the anchor href and/or the img src query
param so both reference the same repository identifier (e.g., change the img src
repo=... or the anchor href to use "hexclave/stack-auth" or whichever canonical
repo name you want) so the contributor image matches the linked contributors
page.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: f906af1f-1aab-48e5-9896-ded558072482
⛔ Files ignored due to path filters (22)
.github/assets/app-shots/analytics.pngis excluded by!**/*.png.github/assets/app-shots/api-keys.pngis excluded by!**/*.png.github/assets/app-shots/authentication.pngis excluded by!**/*.png.github/assets/app-shots/data-vault.pngis excluded by!**/*.png.github/assets/app-shots/emails.pngis excluded by!**/*.png.github/assets/app-shots/launch-checklist.pngis excluded by!**/*.png.github/assets/app-shots/payments.pngis excluded by!**/*.png.github/assets/app-shots/rbac.pngis excluded by!**/*.png.github/assets/app-shots/teams.pngis excluded by!**/*.png.github/assets/app-shots/webhooks.pngis excluded by!**/*.png.github/assets/comparison.pngis excluded by!**/*.png.github/assets/hexclave-header.svgis excluded by!**/*.svg.github/assets/logos/analytics.pngis excluded by!**/*.png.github/assets/logos/api-keys.pngis excluded by!**/*.png.github/assets/logos/authentication.pngis excluded by!**/*.png.github/assets/logos/data-vault.pngis excluded by!**/*.png.github/assets/logos/emails.pngis excluded by!**/*.png.github/assets/logos/launch-checklist.pngis excluded by!**/*.png.github/assets/logos/payments.pngis excluded by!**/*.png.github/assets/logos/rbac.pngis excluded by!**/*.png.github/assets/logos/teams.pngis excluded by!**/*.png.github/assets/logos/webhooks.pngis excluded by!**/*.png
📒 Files selected for processing (3)
.github/workflows/table-of-contents.yamlCONTRIBUTING.mdREADME.md
… lint and contrib.rocks URL - CONTRIBUTING.md: replace Stack Auth branding/domains/security email with Hexclave equivalents - .github/SECURITY.md: same rebrand (security@hexclave.com, team@hexclave.com) so disclosure flow matches README - README.md: add language to fenced code block (markdownlint MD040), add alt="" to 10 decorative heading logos (MD045), fix contrib.rocks URL to point at hexclave/stack-auth
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 24-25: Check and correct the contributor-facing Discord link and
security mailbox info: verify that the Discord URL
"https://discord.hexclave.com" resolves publicly (or replace it with the
canonical invite/Discord URL if it does not), ensure the docs link
"https://docs.hexclave.com" remains listed, and update the CONTRIBUTING.md entry
that currently contains those links to the working Discord URL or a note about
alternate community channels; separately verify that the email
"security@hexclave.com" is backed by valid MX records and is actively monitored
for vulnerability reports and, if not, replace or add a monitored contact (or a
vulnerability disclosure process link) in the CONTRIBUTING.md so reporters have
a working, monitored channel.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: cc77d083-54ed-4963-98c2-2c8cf6e12e18
📒 Files selected for processing (3)
.github/SECURITY.mdCONTRIBUTING.mdREADME.md
✅ Files skipped from review due to trivial changes (2)
- .github/SECURITY.md
- README.md
N2D4
approved these changes
May 23, 2026
Collaborator
Author
|
waiting to merge until app.hexclave.com, try.hexclave.com, etc. are all setup |
N2D4
approved these changes
May 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Read try.hexclave.com and help me setup hexclave in this project)CONTRIBUTING.md, Discord, and the security contacthexclave/stack-authrepo on contrib.rocksNote: an explicit SDKs section was intentionally dropped for now — the
@hexclave/next,@hexclave/react,@hexclave/jspackages 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.comThis keeps the disclosure flow consistent across the three docs.
Markdown lint / a11y polish
textlanguage tag to the bare fenced block under "Get started" (markdownlint MD040)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 decorativeOpen items
A few rebrand details still need confirmation; this PR assumes them and uses them in copy:
hexclave.com,docs.hexclave.com,app.hexclave.com,discord.hexclave.com,security@hexclave.com,team@hexclave.com. Onlytry.hexclave.comis confirmed.try.hexclave.comsetup-prompt page needs to exist for the Get started flow to work.Summary by CodeRabbit