chore: Update docusaurus doc titles#452
Conversation
Co-authored-by: universe <universe@grida.co>
|
Cursor Agent can help with this pull request. Just |
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughMultiple documentation files in the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~8 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/wg/feat-crdt/id.md (1)
1-4: Title update improves clarity and sidebar navigation; minor heading alignment consideration.The YAML front matter title has been streamlined from the verbose original to "CRDT Object ID Model," which provides a clearer label for Docusaurus sidebar navigation. The "working group draft" context is appropriately preserved in the description field rather than cluttering the title.
The only minor observation is that the YAML title ("CRDT Object ID Model") now differs slightly from the main H1 heading ("Grida ID Model (for CRDT)"). While this is common in Docusaurus workflows, you may want to consider whether the two should be more aligned for consistency. If unifying them is preferred, consider either:
- Updating the H1 to match the YAML title for consistency, or
- Keeping the current approach (which is also valid and common).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
docs/wg/feat-2d/optimization.md(1 hunks)docs/wg/feat-crdt/id.md(1 hunks)docs/wg/feat-fontgen/index.md(1 hunks)docs/wg/feat-hash-nch/index.md(1 hunks)docs/wg/feat-icu-uct/index.md(1 hunks)docs/wg/feat-image-filters/index.md(1 hunks)docs/wg/feat-layout/index.md(1 hunks)docs/wg/feat-masks/index.md(1 hunks)docs/wg/feat-painting/fe-noise.md(1 hunks)docs/wg/feat-painting/stroke-rect.md(1 hunks)docs/wg/feat-paragraph/impl-emoji-placeholder.md(1 hunks)docs/wg/feat-paragraph/impl-font-fallback.md(1 hunks)docs/wg/feat-paragraph/impl-italic.md(1 hunks)docs/wg/feat-paragraph/impl-opsz-auto.md(1 hunks)docs/wg/feat-paragraph/index.md(1 hunks)docs/wg/feat-resources/index.md(1 hunks)docs/wg/feat-vector-network/index.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**
📄 CodeRabbit inference engine (AGENTS.md)
Author and maintain all documentation under the root docs directory; it is the source of truth
Files:
docs/wg/feat-paragraph/impl-font-fallback.mddocs/wg/feat-paragraph/impl-italic.mddocs/wg/feat-hash-nch/index.mddocs/wg/feat-painting/stroke-rect.mddocs/wg/feat-paragraph/index.mddocs/wg/feat-layout/index.mddocs/wg/feat-paragraph/impl-emoji-placeholder.mddocs/wg/feat-paragraph/impl-opsz-auto.mddocs/wg/feat-image-filters/index.mddocs/wg/feat-icu-uct/index.mddocs/wg/feat-2d/optimization.mddocs/wg/feat-painting/fe-noise.mddocs/wg/feat-vector-network/index.mddocs/wg/feat-resources/index.mddocs/wg/feat-fontgen/index.mddocs/wg/feat-crdt/id.mddocs/wg/feat-masks/index.md
🧠 Learnings (2)
📚 Learning: 2025-09-15T10:31:32.864Z
Learnt from: CR
Repo: gridaco/grida PR: 0
File: crates/grida-canvas-fonts/AGENTS.md:0-0
Timestamp: 2025-09-15T10:31:32.864Z
Learning: Applies to crates/grida-canvas-fonts/tests/italic_level1.rs : Place core font selection and italic detection tests in tests/italic_level1.rs
Applied to files:
docs/wg/feat-paragraph/impl-italic.md
📚 Learning: 2025-09-15T10:31:32.864Z
Learnt from: CR
Repo: gridaco/grida PR: 0
File: crates/grida-canvas-fonts/AGENTS.md:0-0
Timestamp: 2025-09-15T10:31:32.864Z
Learning: Applies to crates/grida-canvas-fonts/tests/italic_name_checking.rs : Put name-based italic detection tests in tests/italic_name_checking.rs
Applied to files:
docs/wg/feat-paragraph/impl-italic.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: cargo test
🔇 Additional comments (16)
docs/wg/feat-vector-network/index.md (1)
1-3: Docusaurus metadata title addition looks good.The YAML front matter is properly formatted and provides a clear, descriptive title for the page. No content changes to the documentation body.
docs/wg/feat-layout/index.md (1)
1-3: Docusaurus metadata title addition is consistent and well-formatted.Clear, descriptive title with feature ID. Metadata-only change; documentation body remains intact.
docs/wg/feat-hash-nch/index.md (1)
1-3: Docusaurus metadata title addition is well-formed.Descriptive title with feature ID. Metadata-only change; documentation content is preserved.
docs/wg/feat-masks/index.md (1)
1-3: Docusaurus metadata title addition is consistent and proper.Clear title with feature ID in parentheses. Metadata-only change; content body is unchanged.
docs/wg/feat-painting/fe-noise.md (1)
1-3: Docusaurus metadata title addition is well-formatted.Descriptive title with feature ID. Metadata-only change; documentation content remains intact.
docs/wg/feat-2d/optimization.md (1)
1-3: Docusaurus metadata title addition is appropriate.Clear, descriptive title. Metadata-only change; documentation content is preserved.
docs/wg/feat-resources/index.md (1)
1-3: Docusaurus metadata title addition is well-formed.Descriptive title with feature ID. Metadata-only change; documentation content is unchanged.
docs/wg/feat-icu-uct/index.md (1)
2-2: Title simplification improves clarity.Removing the "- Working Group Draft" suffix from the title streamlines the page heading while the description field still conveys the working group status. This aligns with the PR's objective to provide clear, consistent titles. Metadata-only change; documentation content is preserved.
docs/wg/feat-fontgen/index.md (1)
1-3: LGTM! Title metadata is clear and descriptive for sidebar navigation, following consistent naming conventions across the PR.docs/wg/feat-painting/stroke-rect.md (1)
1-3: LGTM! Clear, descriptive title appropriate for documentation sidebar navigation.docs/wg/feat-image-filters/index.md (1)
1-3: LGTM! Title is consistent with the established naming pattern and provides clear navigation context.docs/wg/feat-paragraph/impl-emoji-placeholder.md (1)
1-3: LGTM! Title metadata appropriately identifies this as an emoji placeholder rendering implementation.docs/wg/feat-paragraph/impl-opsz-auto.md (1)
1-3: LGTM! Title clearly identifies the optical size automation feature with consistent naming convention.docs/wg/feat-paragraph/impl-italic.md (1)
1-3: LGTM! Title metadata is descriptive and appropriately reflects the documentation scope on italic and oblique strategies.docs/wg/feat-paragraph/impl-font-fallback.md (1)
1-3: LGTM! Title clearly identifies the font fallback strategy documentation with consistent naming.docs/wg/feat-paragraph/index.md (1)
1-5: LGTM! Title and roadmap structure provide clear organization for the Paragraph feature documentation. The categorized checklist format improves navigation and status tracking.
softmarshmallow
changed the title
2 participants
Update Docusaurus titles in
docs/wgdocuments to provide clear and consistent sidebar and page headings, replacing placeholder or verbose titles.Note
Adds/normalizes front‑matter
titlefields acrossdocs/wgpages and shortens a few verbose titles for consistent sidebar/page headings.titlein:docs/wg/feat-2d/optimization.md,feat-fontgen/index.md,feat-hash-nch/index.md,feat-image-filters/index.md,feat-layout/index.md,feat-masks/index.md,feat-painting/fe-noise.md,feat-painting/stroke-rect.md,feat-paragraph/impl-emoji-placeholder.md,feat-paragraph/impl-font-fallback.md,feat-paragraph/impl-italic.md,feat-paragraph/impl-opsz-auto.md,feat-paragraph/index.md,feat-resources/index.md,feat-vector-network/index.md.feat-crdt/id.md→ "CRDT Object ID Model"feat-icu-uct/index.md→ "Unicode Coverage Tracker (UCT)"Written by Cursor Bugbot for commit 29c6c36. This will update automatically on new commits. Configure here.
Summary by CodeRabbit