Update documentation site and homepage for Docs editor#75
Merged
Conversation
- Hero: "Spreadsheet & Word Processor You Can Own" - Why: compare against Google Workspace, add Sheets & Docs row - Features: add Document Editor card, 2x2 secondary grid - Developer: generalize subtitle, fix broken doc link paths - Demo/Footer: minor wording and link fixes Co-Authored-By: Claude Opus 4.6 <[email protected]>
📝 WalkthroughWalkthroughComprehensive documentation reorganization introducing Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 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 docstrings
🧪 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 |
Contributor
Verification: verify:selfResult: ✅ PASS in 104.7s
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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/documentation/developers/cli.md (1)
119-137:⚠️ Potential issue | 🟠 Major
document create --typeis documented, but not implemented in the CLI.Line 123 and Line 137 describe
--type, butpackages/cli/src/commands/document.tscurrently definescreate <title>with no--typeoption and sends onlytitletocreateDocument(...). This will mislead users and cause command failure/unknown-option behavior.Please either implement
--typeinpackages/cli/src/commands/document.tsin this PR, or remove this option from docs until the CLI support lands.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/documentation/developers/cli.md` around lines 119 - 137, The docs advertise a --type option for the CLI but the command handler "create <title>" doesn't accept or forward it; update the command definition for the create command to accept an optional --type <type> flag (defaulting to "sheet"), validate it against allowed values "sheet" and "doc", and pass the resolved type as a second argument to createDocument (e.g., createDocument(title, type)); if createDocument's signature doesn't support a type yet, update its caller/callee to accept and forward the type to the API call. Ensure the flag is registered on the same command that defines "create <title>" and that unknown values return a friendly error.
🧹 Nitpick comments (1)
docs/superpowers/plans/2026-03-24-docs-documentation-update.md (1)
617-625: Consider adding language specifiers to fenced code blocks.Static analysis flagged these blocks for missing language identifiers. For plain text content like this, you can use
```textto satisfy the linter.📝 Suggested fix
-``` +```text The Wafflebase REST API lets you read and write spreadsheet data programmatically.-To:
-+ +To: + +text
The Wafflebase REST API lets you read and write spreadsheet and document data programmatically.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/superpowers/plans/2026-03-24-docs-documentation-update.md` around lines 617 - 625, Update the first line string "The Wafflebase REST API lets you read and write spreadsheet data programmatically." to include "and document" so it reads "The Wafflebase REST API lets you read and write spreadsheet and document data programmatically.", and add language specifiers to the fenced code blocks around that sentence by changing the triple-backtick fences to use ```text for both the original and updated fenced blocks; modify the fenced block markers that currently are plain ``` so they become ```text to satisfy the linter.
🤖 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/documentation/developers/rest-api.md`:
- Line 3: The opening sentence overstates REST capabilities by claiming it
supports "document data"; update that sentence to accurately state the API
exposes spreadsheet sheet cell data and document metadata (not full document
content) under "/api/v1/". Locate the sentence containing the phrase "The
Wafflebase REST API lets you read and write spreadsheet and document data
programmatically" and replace "document data" with "document metadata and sheet
cell data" (or similar wording) so it aligns with the later note that full doc
content is not available via REST.
---
Outside diff comments:
In `@packages/documentation/developers/cli.md`:
- Around line 119-137: The docs advertise a --type option for the CLI but the
command handler "create <title>" doesn't accept or forward it; update the
command definition for the create command to accept an optional --type <type>
flag (defaulting to "sheet"), validate it against allowed values "sheet" and
"doc", and pass the resolved type as a second argument to createDocument (e.g.,
createDocument(title, type)); if createDocument's signature doesn't support a
type yet, update its caller/callee to accept and forward the type to the API
call. Ensure the flag is registered on the same command that defines "create
<title>" and that unknown values return a friendly error.
---
Nitpick comments:
In `@docs/superpowers/plans/2026-03-24-docs-documentation-update.md`:
- Around line 617-625: Update the first line string "The Wafflebase REST API
lets you read and write spreadsheet data programmatically." to include "and
document" so it reads "The Wafflebase REST API lets you read and write
spreadsheet and document data programmatically.", and add language specifiers to
the fenced code blocks around that sentence by changing the triple-backtick
fences to use ```text for both the original and updated fenced blocks; modify
the fenced block markers that currently are plain ``` so they become ```text to
satisfy the linter.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 500561a7-8cb3-4f67-91e2-d1a604bab0f6
📒 Files selected for processing (19)
docs/superpowers/plans/2026-03-24-docs-documentation-update.mdpackages/documentation/.vitepress/config.tspackages/documentation/README.mdpackages/documentation/developers/cli.mdpackages/documentation/developers/rest-api.mdpackages/documentation/docs-editor/keyboard-shortcuts.mdpackages/documentation/docs-editor/writing-a-document.mdpackages/documentation/guide/collaboration.mdpackages/documentation/guide/getting-started.mdpackages/documentation/sheets/build-a-budget.mdpackages/documentation/sheets/charts.mdpackages/documentation/sheets/formulas.mdpackages/documentation/sheets/keyboard-shortcuts.mdpackages/frontend/src/app/home/demo-section.tsxpackages/frontend/src/app/home/developer-section.tsxpackages/frontend/src/app/home/features-section.tsxpackages/frontend/src/app/home/footer.tsxpackages/frontend/src/app/home/hero-section.tsxpackages/frontend/src/app/home/why-section.tsx
| # REST API | ||
|
|
||
| The Wafflebase REST API lets you read and write spreadsheet data programmatically. All endpoints are under `/api/v1/`. | ||
| The Wafflebase REST API lets you read and write spreadsheet and document data programmatically. All endpoints are under `/api/v1/`. |
There was a problem hiding this comment.
Opening sentence overstates current REST support for docs.
Line 3 says the API can read/write “document data,” but Line 102 states doc content is not available via REST yet. Consider clarifying this as document metadata + sheet cell data to avoid contradiction.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/documentation/developers/rest-api.md` at line 3, The opening
sentence overstates REST capabilities by claiming it supports "document data";
update that sentence to accurately state the API exposes spreadsheet sheet cell
data and document metadata (not full document content) under "/api/v1/". Locate
the sentence containing the phrase "The Wafflebase REST API lets you read and
write spreadsheet and document data programmatically" and replace "document
data" with "document metadata and sheet cell data" (or similar wording) so it
aligns with the later note that full doc content is not available via REST.
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
"sheet"|"doc") parameterTest plan
pnpm verify:fastpassespnpm verify:selfpasses (all builds succeed)🤖 Generated with Claude Code
Summary by CodeRabbit
Release Notes
New Features
Documentation