Skip to content

docs: update all docs to reflect current codebase (v0.3.0)#29

Merged
nathanialhenniges merged 1 commit intomainfrom
claude/upbeat-feistel-bdc905
May 7, 2026
Merged

docs: update all docs to reflect current codebase (v0.3.0)#29
nathanialhenniges merged 1 commit intomainfrom
claude/upbeat-feistel-bdc905

Conversation

@nathanialhenniges
Copy link
Copy Markdown
Member

@nathanialhenniges nathanialhenniges commented May 7, 2026

Summary

  • Add guide/connections.mdx — new guide for the Connections inbox (contact form submissions, filtering, bulk actions, email notification setup)
  • Add Location block (7th block type) to guide/blocks.mdx; fix block count 6→7
  • Add Social icon shape and Consent Banner sections to guide/appearance.mdx
  • Add Rate limiting section (RL_AUTH / RL_STRICT / RL_UPLOAD / RL_PUBLIC) to guide/security.mdx
  • Add connections to guide/meta.json sidebar nav
  • Full rewrite of self-hosting/cloudflare.mdx — ADHD-friendly 6-step guide with TL;DR, expanded API token permissions table, WALLET_* optional env block, troubleshooting section, and cost table
  • Add WALLET_* optional env vars section + updated .env example in self-hosting/environment-variables.mdx
  • Add MapKit, consent banner, and admin branding to admin settings list in getting-started/configuration.mdx
  • Add v0.3.0 changelog entry covering analytics page, setup wizard, location block, social icon shape, connections rename, rate limiting, and WALLET_* vars
  • Update README.md features list (location block, connections inbox, consent banner, rate limiting)
  • Update CLAUDE.md with full settings key groups, new design patterns (social icon shape, consent banner, mapkit, admin branding, connections page, setup wizard), and corrected command list

What prompted this

Pulled latest main (2 new commits — social icon shape section). Codebase had outpaced docs across several areas: new block type, new admin page, new settings, and the Cloudflare deploy guide needed a dummy-proof rewrite.

Reviewer notes

  • All changes are doc-only (.mdx, .md, .json). No code changes.
  • cloudflare.mdx is a significant rewrite in length — the old version was ~120 lines, new is ~170 — but content is strictly more accurate and complete.
  • connections.mdx is a net-new file; sidebar position is between analytics and contact-form in meta.json.

Test plan

  • bun dev:docs → open http://localhost:3002
  • Verify Connections appears in the Guide sidebar
  • Verify Location appears under Block Types in the Blocks guide
  • Verify Cloudflare deploy guide renders all 6 numbered steps cleanly
  • Verify WALLET_* section appears in Environment Variables reference

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

    • Added Location block supporting Apple Maps (MapKit) and Google Maps with customizable height and zoom.
    • Introduced social icon shape configuration (Circle vs Rounded square).
    • Added configurable consent banner to Appearance settings.
    • Launched Connections inbox for managing contact form submissions with read/unread filtering and bulk actions.
    • New admin setup wizard and redesigned login experience.
  • Documentation

    • Expanded guides covering all new appearance options, blocks, and admin features.
    • Improved Cloudflare deployment documentation with detailed step-by-step instructions.

- Add location block type (7th block) to blocks guide
- Add connections.mdx guide for contact form submissions inbox
- Add connections to guide/meta.json sidebar nav
- Add social icon shape + consent banner sections to appearance guide
- Add rate limiting section (RL_AUTH/STRICT/UPLOAD/PUBLIC) to security guide
- Add WALLET_* optional vars section to environment-variables.mdx
- Rewrite cloudflare.mdx as ADHD-friendly step-by-step (6 numbered steps,
  TL;DR, troubleshooting, cost table, WALLET_* optional env block)
- Add consent_banner, mapkit, admin_branding to configuration.mdx admin settings list
- Add v0.3.0 changelog entry (analytics page, setup wizard, location block,
  social icon shape, connections rename, rate limiting, WALLET_* vars)
- Update README.md features list (location block, connections inbox, consent banner)
- Update CLAUDE.md with full settings key groups, new design patterns,
  connections page, setup wizard, and corrected command list

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This pull request updates documentation across the LinkDen project to reflect v0.3.0 features: a new location block type, social icon shape customization, consent banner configuration, connections inbox for contact submissions, MapKit integration, admin branding controls, Cloudflare rate limiting, and Apple Wallet signing support. The changes span project README, internal architecture notes, feature guides, deployment instructions, and release notes.

Changes

v0.3.0 Feature Documentation

Layer / File(s) Summary
Project Overview & Architecture
CLAUDE.md, README.md
Project README now lists 7 builder block types and explicitly includes connections inbox, social icon shape, and Cloudflare rate limiting. CLAUDE.md documents new commands (bun ship, bun reset:*), design patterns (social icons, consent banner, MapKit, admin branding), admin routes (/admin/setup, /admin/login), and expanded settings keys.
Appearance Settings Documentation
apps/docs/content/docs/guide/appearance.mdx
New sections for social icon shape selection (Circle vs Rounded square) and optional consent banner configuration, with navigation paths to /admin/appearance for both settings.
Builder Blocks & Connections Inbox
apps/docs/content/docs/guide/blocks.mdx, apps/docs/content/docs/guide/connections.mdx, apps/docs/content/docs/guide/meta.json
Location block (7th type) documented with Apple Maps/MapKit JS support, fallback to Google Maps, configurable height/zoom, and optional MapKit token setup. New Connections inbox page documents contact form submission management with read/unread filtering, bulk delete actions, email notifications, and UI navigation.
Runtime Configuration Guide
apps/docs/content/docs/getting-started/configuration.mdx
Expanded admin settings list to include MapKit token, consent banner configuration, and admin branding toggle alongside existing vCard and Apple Wallet settings.
Security & Infrastructure
apps/docs/content/docs/guide/security.mdx
New rate-limiting section describing Cloudflare Workers rate limiting via Alchemy bindings with four rate-limit buckets (RL_AUTH, RL_STRICT, RL_UPLOAD, RL_PUBLIC) protecting different endpoint types.
Cloudflare Deployment Guide
apps/docs/content/docs/self-hosting/cloudflare.mdx
Comprehensive restructuring into step-based free-tier deployment guide with API token creation matrix, expanded .env template (Cloudflare credentials, Better Auth, optional Apple Wallet), first deploy with bun ship output expectations, mandatory URL update/redeploy step, admin account setup via /admin/setup, custom domain configuration, updated commands table, detailed free-tier cost breakdown, and expanded troubleshooting sections.
Environment Variables Documentation
apps/docs/content/docs/self-hosting/environment-variables.mdx
New "Apple Wallet (Optional)" section lists five WALLET_* environment variables with all-or-nothing requirement and security guidance. Complete .env example expanded with commented Cloudflare and Apple Wallet blocks.
Release Notes
apps/docs/content/docs/reference/changelog.mdx
New v0.3.0 (May 2026) changelog entry with bullet-point feature summaries across Analytics, Admin, Appearance, Blocks (location), Connections, Settings (MapKit/branding/consent), and Infrastructure (rate limiting/Apple Wallet).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A document sprint, so bright and clear,
Seven blocks, consent, and MapKit cheer!
Deploy to Cloudflare, no tears, no fuss,
The docs now guide us, all of us!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main change: comprehensive documentation updates to reflect the v0.3.0 codebase release.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/upbeat-feistel-bdc905

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.

@nathanialhenniges nathanialhenniges merged commit 3d096ca into main May 7, 2026
2 of 3 checks passed
@nathanialhenniges nathanialhenniges deleted the claude/upbeat-feistel-bdc905 branch May 7, 2026 22:22
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