Repository navigation
docs(docs): align documentation wording and navigation - #1088
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configuration
You can disable this status message by setting the Use the checkbox below for a quick retry:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (71)
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (1)
🧰 Additional context used📚 Code guidelines (3)📓 Path-based instructions (3)Source excerpt: When you discover a new performance improvement, optimization pattern, or fix a performance regression, add a concise bullet to the relevant section below in the same session.📄 CodeRabbit inference engine (.cursor/rules/performance.mdc) Files:
Source excerpt: MUST use Tailwind CSS defaults unless custom values already exist or are explicitly requested Source excerpt: MUST use motion/react (formerly framer-motion) when JavaScript animation is required Source excerpt: SHOULD use tw...📄 CodeRabbit inference engine (.cursor/rules/ui-guidelines.mdc) Files:
Source excerpt: description: Basic guidelines for the project so vibe coders don't fuck it up globs: alwaysApply: true when using 'text-right', always add 'text-balance' so its not ugly Source excerpt: description: Basic guidelines for the...📄 CodeRabbit inference engine (.cursor/rules/01-MUST-DO.mdc) Files:
🪛 LanguageToolapps/docs/content/docs/api/links.mdx[grammar] ~72-~72: Use a hyphen to join words. (QB_NEW_EN_HYPHEN) apps/docs/content/docs/api/query.mdx[grammar] ~316-~316: Use a hyphen to join words. (QB_NEW_EN_HYPHEN) apps/docs/content/docs/sdk/feature-flags.mdx[grammar] ~402-~402: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) 🔇 Additional comments (10)
WalkthroughThis pull request standardizes capitalization and wording across documentation navigation, integration guides, API and SDK references, and product guides. It also updates selected guide content and landing-page links. ChangesDocumentation updates
Priority: ➖ Normal Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Other Merge Risk: ⚪ Minimal · up to The Svelte setup example is consistent with the documentation’s package-manager options. No actionable issue remains beyond normal checks. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 3 files. (68 skipped: 68 unsupported.) ✨ Finishing Touches 💡 1📝 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 |
|
Please review the complete scoped docs slice at head |
|
@coderabbitai full review Please review the complete scoped docs slice at head |
✅ Action performedFull review finished. |
 |
a3676ee to
527638d
Compare
|
The latest updates on your projects. Learn more about Unkey Deploy
|
|
Please re-review final head |
527638d to
e70d78f
Compare
|
Please re-review final head |
e70d78f to
9c08f47
Compare
|
Please re-review final head |
9c08f47 to
7578093
Compare
|
Please re-review final head |
7578093 to
f490df0
Compare
|
Please re-review final head |
f490df0 to
bacc8be
Compare
|
Please re-review final head |
This branch was successfully deployed
1 participant
Standardize documentation wording, sentence case and product terms, with matching docs navigation and section labels. Preserve current SDK behavior, URLs, examples and the already landed framework/MCP guides.
Scope: one coherent commit,71 files (documentation content/metadata and three docs-only navigation/SEO helpers), targeting main. Split from #1070, which now owns87 disjoint site/interface files. Together both scopes exactly reconstruct the original158-file source. No dependency between them. Known overlap: draft #1078 interaction defaults touches SDK documentation and must preserve this wording when it integrates after tracker delivery.
Validation on
a3676ee8e40fef45bc80c74ff5e90e4f84679213, based on maind8af387041e31eafde63ef8c7e0da9a7bfe29fa3: formatting nine supported TS/JSON files, root lint/types, Fumadocs generation,41 existing docs tests/1,056 assertions and local route/anchor checks passed. The62 Markdown/MDX files are outside Ultracite support. Normal commit/push hooks passed; every owned source mode/blob matches the original reviewed source and all main-only paths are preserved.Fresh configured source review and required CI must finish before merge. No SDK/package/tracker publication is triggered by this docs-only scope.
AI-assisted maintainer change.
Summary by cubic
Standardizes documentation wording, sentence case, and product terminology across docs content, with matching sidebar and navigation labels. Examples include "Getting Started" → "Getting started", "page views" → "pageviews", "Bubble.io" → "Bubble", and "API Reference" → "API reference". URLs, examples, and SDK behavior are unchanged.
sidebar-content.tsx,docs-page-seo.ts,source.ts) so labels match.Written for commit bacc8be. Summary will update on new commits.
Summary by CodeRabbit