Organize design docs into sheets/ and docs/ subdirectories#107
Merged
Conversation
docs/design/ had 38 files in a flat structure, making it hard to navigate. Move sheets-related docs (12 files) into sheets/ and word-processor-related docs (14 files) into docs/, keeping common infrastructure docs flat. Update all cross-references in README index, package READMEs, frontend.md, and task files. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 4 minutes and 32 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughThis pull request reorganizes design document paths by moving documentation files from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
Contributor
Verification: verify:selfResult: ✅ PASS in 115.9s
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: 7
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/design/frontend.md`:
- Line 254: The PR introduced links pointing at docs/design/sheets (e.g., the
"collaboration.md" link and other references to docs/design/sheets/...), which
conflicts with the repo rule requiring design docs under docs/design/ (pattern
docs/design/**/*.md); fix by either moving the referenced markdown files up to
the flat docs/design/ location and updating the link targets to
docs/design/<topic>.md (ensure links like "collaboration.md" now resolve at
docs/design/collaboration.md) or, if you intentionally want a subdirectory,
update the repository guideline text to allow docs/design/sheets/ and adjust the
documented pattern accordingly so the change is consistent.
In `@docs/tasks/archive/2026/03/20260320-docs-package-todo.md`:
- Line 7: The relative link target "**docs/design/docs/docs.md**" is too shallow
for this archived doc (currently "../../design/docs/docs.md" on line 7); update
the link to back up one more directory (use "../../../design/docs/docs.md") so
the link resolves correctly from docs/tasks/archive/2026/03/; edit the Markdown
link in the file (the line containing "../../design/docs/docs.md") to the
corrected "../../../design/docs/docs.md".
In `@docs/tasks/archive/2026/03/20260329-docs-table-selection-todo.md`:
- Line 11: The markdown spec link "docs/design/docs/docs-tables.md" in
docs/tasks/archive/2026/03/20260329-docs-table-selection-todo.md uses an
incorrect relative path ("../../design/docs/docs-tables.md"); update the link to
traverse one more directory up so it points to
"../../../design/docs/docs-tables.md" to ensure the GitHub link resolves
correctly.
In `@docs/tasks/archive/2026/03/20260329-docs-table-ui-todo.md`:
- Line 11: The relative spec link "../../design/docs/docs-table-ui.md" in the
markdown (the link text in 20260329-docs-table-ui-todo.md) is broken; update
that link target to the correct relative path from this file by replacing
"../../design/docs/docs-table-ui.md" with
"../../../../design/docs/docs-table-ui.md" so it resolves to the
docs/design/docs-table-ui.md spec.
In `@docs/tasks/archive/2026/03/20260329-docs-tables-todo.md`:
- Line 11: The Spec link in the markdown currently points to
../../design/docs/docs-tables.md which is two levels up and wrong from this
file; update the link target to ../../../design/docs/docs-tables.md so the
anchor [docs/design/docs/docs-tables.md] points to the correct location (keep
the link text the same and only change the URL).
In `@docs/tasks/archive/2026/03/20260329-table-crdt-phase-a-todo.md`:
- Line 11: Update the broken relative link in the markdown line that reads
"**Spec:** [docs/design/docs/docs-table-crdt.md]" so it resolves from
docs/tasks/archive/2026/03/; replace "../../design/docs/docs-table-crdt.md" with
a correct path such as "../../../../design/docs/docs-table-crdt.md" or the
repo-root absolute "/design/docs/docs-table-crdt.md" so the Spec link renders
properly on GitHub.
In `@docs/tasks/archive/2026/03/20260329-table-crdt-phase-b-todo.md`:
- Line 11: The relative link "docs/design/docs/docs-table-crdt.md" is too
shallow for this file's folder depth; update the Markdown link target to go up
one more directory (use "../../../design/docs/docs-table-crdt.md") so the
reference from the docs/tasks/archive/2026/03 file resolves correctly; change
the link text target in the line containing
"docs/design/docs/docs-table-crdt.md" accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 58660355-3e91-4686-acff-ed4937b6a3ee
📒 Files selected for processing (53)
docs/design/README.mddocs/design/docs/docs-collaboration.mddocs/design/docs/docs-frontend-integration.mddocs/design/docs/docs-intent-preserving-edits.mddocs/design/docs/docs-mobile-zoom-to-fit.mddocs/design/docs/docs-pagination.mddocs/design/docs/docs-remote-cursor.mddocs/design/docs/docs-rendering-optimization.mddocs/design/docs/docs-ruler.mddocs/design/docs/docs-table-crdt.mddocs/design/docs/docs-table-resize.mddocs/design/docs/docs-table-ui.mddocs/design/docs/docs-tables.mddocs/design/docs/docs-wordprocessor-roadmap.mddocs/design/docs/docs.mddocs/design/frontend.mddocs/design/sheets/batch-transactions.mddocs/design/sheets/calculator.mddocs/design/sheets/charts.mddocs/design/sheets/collaboration.mddocs/design/sheets/conditional-format-multi-range.mddocs/design/sheets/datasource.mddocs/design/sheets/formula-coverage.mddocs/design/sheets/formula.mddocs/design/sheets/pivot-table.mddocs/design/sheets/scroll-and-rendering.mddocs/design/sheets/sheet-style.mddocs/design/sheets/sheet.mddocs/tasks/active/20260403-intent-preserving-phase4-table-cells-todo.mddocs/tasks/active/20260403-intent-preserving-phase5-undo-redo-todo.mddocs/tasks/archive/2026/03/20260314-collaboration-design-docs-todo.mddocs/tasks/archive/2026/03/20260314-yorkie-worksheet-shape-migration-todo.mddocs/tasks/archive/2026/03/20260320-docs-package-todo.mddocs/tasks/archive/2026/03/20260321-cf-multi-range-todo.mddocs/tasks/archive/2026/03/20260321-docs-pagination-todo.mddocs/tasks/archive/2026/03/20260321-pr58-review-todo.mddocs/tasks/archive/2026/03/20260322-docs-collaboration-todo.mddocs/tasks/archive/2026/03/20260322-docs-rendering-optimization-todo.mddocs/tasks/archive/2026/03/20260323-docs-frontend-integration-todo.mddocs/tasks/archive/2026/03/20260323-yorkie-doc-store-todo.mddocs/tasks/archive/2026/03/20260324-docs-remote-cursor-todo.mddocs/tasks/archive/2026/03/20260326-docs-phase2-todo.mddocs/tasks/archive/2026/03/20260328-docs-mobile-zoom-to-fit-todo.mddocs/tasks/archive/2026/03/20260329-docs-table-selection-todo.mddocs/tasks/archive/2026/03/20260329-docs-table-ui-todo.mddocs/tasks/archive/2026/03/20260329-docs-tables-todo.mddocs/tasks/archive/2026/03/20260329-table-crdt-phase-a-todo.mddocs/tasks/archive/2026/03/20260329-table-crdt-phase-b-todo.mddocs/tasks/archive/2026/03/20260329-table-granular-updates-todo.mddocs/tasks/archive/2026/03/20260331-table-resize-todo.mddocs/tasks/archive/2026/04/20260402-intent-preserving-phase1-3-todo.mdpackages/docs/README.mdpackages/sheets/README.md
The markdown links used ../../design/ but the files are 5 levels deep (docs/tasks/archive/2026/03/), so the correct relative path is ../../../../design/. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
2 tasks
12 tasks
3 tasks
6 tasks
This was referenced Jun 22, 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
docs/design/sheets/docs/design/docs/docs/design/Test plan
pnpm verify:fastpasses🤖 Generated with Claude Code
Summary by CodeRabbit