Skip to content

Rebuild README.md for the Hexclave rebrand#1474

Draft
BilalG1 wants to merge 13 commits into
devfrom
cl/brave-keller-9ac5a8
Draft

Rebuild README.md for the Hexclave rebrand#1474
BilalG1 wants to merge 13 commits into
devfrom
cl/brave-keller-9ac5a8

Conversation

@BilalG1
Copy link
Copy Markdown
Collaborator

@BilalG1 BilalG1 commented May 22, 2026

Summary

Rebuilds the project README from scratch for the Stack Auth to Hexclave rebrand. The previous README was out of date.

New structure:

  • Top section: name, "The user infrastructure platform" tagline, intro paragraph, links, and badges
  • Get started: a single AI-agent setup prompt (Read try.hexclave.com and help me setup hexclave in this project)
  • What's included: a catalog of the non-alpha apps
  • SDKs: @hexclave/next, @hexclave/react, @hexclave/js, plus the REST API, with a docs link
  • Contributing: pointer to CONTRIBUTING.md, Discord, and the security contact

Also fixes a stale anchor in CONTRIBUTING.md (README.md#-development--contribution) that pointed to a section removed in the rewrite; it now points to #contributing.

Open items (draft)

Draft because a few rebrand details still need confirmation:

  • Domains assumed: hexclave.com, docs.hexclave.com, app.hexclave.com, discord.hexclave.com, security@hexclave.com. Only try.hexclave.com is confirmed.
  • SDK package names @hexclave/next, @hexclave/react, @hexclave/js are not yet published under that scope.
  • License and Self-hosting sections were intentionally omitted; the header badges were kept.
  • The try.hexclave.com setup-prompt page needs to exist for the Get started flow to work.

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.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
stack-auth-hosted-components Ready Ready Preview, Comment May 22, 2026 11:42pm
stack-auth-mcp Ready Ready Preview, Comment May 22, 2026 11:42pm
stack-auth-skills Ready Ready Preview, Comment May 22, 2026 11:42pm
stack-backend Ready Ready Preview, Comment May 22, 2026 11:42pm
stack-dashboard Ready Ready Preview, Comment May 22, 2026 11:42pm
stack-demo Ready Ready Preview, Comment May 22, 2026 11:42pm
stack-docs Building Building Preview, Comment May 22, 2026 11:42pm
stack-preview-backend Ready Ready Preview, Comment May 22, 2026 11:42pm
stack-preview-dashboard Ready Ready Preview, Comment May 22, 2026 11:42pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 707ee79c-6df5-4580-88a0-8f0b4c1e1cc9

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cl/brave-keller-9ac5a8

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.

BilalG1 and others added 3 commits May 22, 2026 15:17
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.
BilalG1 added 2 commits May 22, 2026 15:31
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.
…shots

Add README-1.md to test an alternative layout for the 'What's included'
section. Each app is rendered as a 2-column table: heading, logo, and
description on the left; a focused, zoomed-in screenshot on the right.

Authentication uses the Sign-in live preview card from the auth-methods
page; Teams uses a cropped team detail view with members and permissions.
Only Authentication and Teams are populated for now to evaluate the
layout before applying it across all apps.

Screenshots live in .github/assets/app-shots/.
Apply the side-by-side pattern to all 10 apps in 'What's included'.
Every app screenshot is now 1100x500, captured from the local
dashboard in dark mode, and padded with the GitHub dark theme
background color (#0d1117) where needed so they blend into the
README page.

Each app shows its most distinctive feature view:
- Authentication: sign-in methods config + live preview side by side
- Teams: team detail with members and permissions
- RBAC: team permissions list with descriptions
- API Keys: API key settings card with type toggles
- Payments: product lines catalog with a real product card
- Emails: sent log with subjects, statuses, and domain reputation
- Analytics: users table with seeded demo data
- Webhooks: 'Create new endpoint' modal
- Data Vault: 'Create Data Vault Store' modal
- Launch Checklist: progress tracker with 0/6 checks completed
Address feedback that several screenshots looked weirdly cropped or
empty:

- Authentication: wider viewport (1800) so both Sign-In Methods config
  and the Live Preview sign-in card are fully visible, no longer half-
  cropped.
- API Keys: tighter crop to the centered content cards, no longer
  truncated on the right.
- Payments: crop starts below the test-mode banner and stripe-auth
  error, focused on the Product Lines section with the real product
  card.
- Webhooks: replaced the create-endpoint modal with a real production
  Activity-tab screenshot (Endpoints / Event Catalog / Logs / Activity
  tabs visible, Historical Delivery Attempts stats, Recent Activity
  chart).
- Data Vault: replaced the create-store modal with the existing
  storeDesc-data-vault-4 screenshot, which shows a real store plus the
  SDK code example for getValue/setValue.
- Launch Checklist: tighter crop around the 0/6 progress card and
  Domains & callbacks section.
- Teams, RBAC, Emails, Analytics: recaptured at the same 1800 viewport
  with the same crop region so the whole catalog looks consistent.
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.

1 participant