Improve homepage UX and reorganize docs site#37
Merged
Conversation
- Center-align check/x icons in Why Wafflebase comparison table - Link feature cards to corresponding docs pages with hover effects - Reorganize docs sidebar: Guide (users) vs Developers (self-hosting, REST API, CLI) - Add new docs: Charts & Pivot Tables, Self-Hosting - Merge Collaboration and Sharing into a single page to remove overlap - Fix viewer description inconsistency in sharing content - Simplify technical jargon in user-facing docs Co-Authored-By: Claude Opus 4.6 <[email protected]>
📝 WalkthroughWalkthroughThis pull request updates navigation, documentation structure, and frontend homepage components. It adds self-hosting documentation, introduces a new Charts & Pivot Tables guide, reorganizes the sidebar navigation to group developer resources, updates collaboration guide content, and makes homepage feature cards navigable with href links. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
📝 Coding Plan
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 |
Contributor
Verification: verify:selfResult: ✅ PASS in 96.6s
Verification: verify:integrationResult: ✅ PASS |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/docs/developers/self-hosting.md`:
- Around line 60-66: The fenced ASCII-art architecture block lacks a language
specifier causing MD040; update the opening fence for that block (the
triple-backtick that begins the Browser ──── Frontend... diagram in the
self-hosting.md file) to include a language identifier such as text (e.g.,
```text) so the code fence is properly annotated for the markdown linter.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c49bb9f1-4ac5-4046-852f-3cf36c2963f7
📒 Files selected for processing (10)
packages/docs/.vitepress/config.tspackages/docs/developers/cli.mdpackages/docs/developers/rest-api.mdpackages/docs/developers/self-hosting.mdpackages/docs/guide/build-a-budget.mdpackages/docs/guide/charts.mdpackages/docs/guide/collaboration.mdpackages/docs/guide/getting-started.mdpackages/frontend/src/app/home/features-section.tsxpackages/frontend/src/app/home/why-section.tsx
Comment on lines
+60
to
+66
| ``` | ||
| Browser ──── Frontend (React/Vite) ──── Backend (NestJS) | ||
| │ | ||
| ┌─────┴─────┐ | ||
| PostgreSQL Yorkie Server | ||
| (metadata) (CRDT sync) | ||
| ``` |
There was a problem hiding this comment.
Add a language identifier to the architecture code fence.
Line 60 starts a fenced block without a language, which can trigger markdown lint failures (MD040).
💡 Suggested fix
-```
+```text
Browser ──── Frontend (React/Vite) ──── Backend (NestJS)
│
┌─────┴─────┐
PostgreSQL Yorkie Server
(metadata) (CRDT sync)</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 60-60: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/docs/developers/self-hosting.md` around lines 60 - 66, The fenced
ASCII-art architecture block lacks a language specifier causing MD040; update
the opening fence for that block (the triple-backtick that begins the Browser
──── Frontend... diagram in the self-hosting.md file) to include a language
identifier such as text (e.g., ```text) so the code fence is properly annotated
for the markdown linter.
This was referenced Mar 21, 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
1 participant
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
Test plan
pnpm verify:fastpasses🤖 Generated with Claude Code
Summary by CodeRabbit
Release Notes
New Features
Documentation