Rebuild README.md for the Hexclave rebrand#1474
Draft
BilalG1 wants to merge 13 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
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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.
…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.
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
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 to Hexclave rebrand. The previous README was out of date.
New structure:
Read try.hexclave.com and help me setup hexclave in this project)@hexclave/next,@hexclave/react,@hexclave/js, plus the REST API, with a docs linkAlso 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:
hexclave.com,docs.hexclave.com,app.hexclave.com,discord.hexclave.com,security@hexclave.com. Onlytry.hexclave.comis confirmed.@hexclave/next,@hexclave/react,@hexclave/jsare not yet published under that scope.try.hexclave.comsetup-prompt page needs to exist for the Get started flow to work.