docs: minor site improvements - #326
Conversation
|
Important Review skippedToo many files! This PR contains 193 files, which is 43 over the limit of 150. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (193)
You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThe site theme extends with ChangesSite Theme and Component Styling
Documentation Structure and Content
App UI and Feature Updates
i18n Utilities Improvements
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
Possibly related PRs
🚥 Pre-merge checks | ✅ 1 | ❌ 4❌ Failed checks (2 warnings, 2 inconclusive)
✅ Passed checks (1 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 |
Cloudflare Pages DeploymentEvent Name: pull_request Wrangler Output⛅️ wrangler 4.100.0 🌎 Deploying... |
![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
🧹 Nitpick comments (2)
packages/site/src/theme/index.ts (2)
145-157: ⚡ Quick winReplace hardcoded colors with token references for consistency.
The
codeBlockslot recipe uses hardcoded hex colors (#f1eae0,#191919) instead of the newly defined design tokens. This is inconsistent with the PR's goal of migrating to design tokens.♻️ Refactor to use design tokens
slotRecipes: { codeBlock: defineSlotRecipe({ slots: codeBlockAnatomy.keys(), base: { code: { '& ::selection': { - bg: '`#f1eae0`', - color: '`#191919`', + bg: 'sand.200', + color: 'typography.base', }, }, }, }), },🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/site/src/theme/index.ts` around lines 145 - 157, The codeBlock slot recipe in the slotRecipes object uses hardcoded hex color values for the selection styling instead of design tokens. Replace the hardcoded colors in the base.code['& ::selection'] block within the defineSlotRecipe call: replace the bg value '`#f1eae0`' with the appropriate background design token reference and the color value '`#191919`' with the appropriate text color design token reference to maintain consistency with the design token migration.
163-165: ⚡ Quick winReplace hardcoded color with token reference for consistency.
The global
::selectionbackground uses a hardcoded hex color instead of a token reference. Line 167 demonstrates that token references work inglobalCss(e.g.,bg: 'bg.canvas'), so this should follow the same pattern.♻️ Refactor to use design tokens
'::selection': { - bg: '`#f1eae0`', + bg: 'sand.200', },🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/site/src/theme/index.ts` around lines 163 - 165, In the `::selection` pseudo-element styling block, replace the hardcoded hex color value `#f1eae0` assigned to the `bg` property with an appropriate design token reference (similar to how `bg: 'bg.canvas'` is used elsewhere in the globalCss configuration). Identify the correct token from your design system that represents this selection background color and use the token reference instead of the hardcoded color value.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/site/src/features/Download/index.tsx`:
- Around line 235-239: Update the code string passed to the SimpleCodeBlock
component to include the correct Homebrew command sequence. The string should
include three commands in this exact order: first brew tap deepinkapp/tap, then
brew trust deepinkapp/tap, and finally brew install deepinkapp/tap/deepink.
Ensure the commands are properly separated by newline characters (\n) to
maintain the multi-line format. The missing brew tap command must be added and
the trust command must be repositioned to execute before the install command.
---
Nitpick comments:
In `@packages/site/src/theme/index.ts`:
- Around line 145-157: The codeBlock slot recipe in the slotRecipes object uses
hardcoded hex color values for the selection styling instead of design tokens.
Replace the hardcoded colors in the base.code['& ::selection'] block within the
defineSlotRecipe call: replace the bg value '`#f1eae0`' with the appropriate
background design token reference and the color value '`#191919`' with the
appropriate text color design token reference to maintain consistency with the
design token migration.
- Around line 163-165: In the `::selection` pseudo-element styling block,
replace the hardcoded hex color value `#f1eae0` assigned to the `bg` property
with an appropriate design token reference (similar to how `bg: 'bg.canvas'` is
used elsewhere in the globalCss configuration). Identify the correct token from
your design system that represents this selection background color and use the
token reference instead of the hardcoded color value.
🪄 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 Plus
Run ID: 5a696c38-89a5-425e-91fd-5d9cf741413a
📒 Files selected for processing (5)
packages/site/src/components/Link.tsxpackages/site/src/components/MarkdownContent.astropackages/site/src/features/Download/index.tsxpackages/site/src/features/releases.tspackages/site/src/theme/index.ts
Cloudflare Pages DeploymentEvent Name: pull_request Wrangler Output⛅️ wrangler 4.100.0 🌎 Deploying... |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/site/src/content/docs/guides/import-export.md`:
- Around line 25-37: Fix two grammatical errors in the Export section of the
import-export.md file. First, change the sentence "You can export as single note
as whole workspace." to "You can export a single note or a whole workspace." to
correct the preposition and add proper article usage. Second, fix the
subject-verb agreement error in "This way let you export all notes" by changing
it to either "This way lets you export all notes" or restructuring it as "This
way allows you to export all notes" for better clarity.
🪄 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 Plus
Run ID: 46131887-bc77-45e7-a04b-e088788e6524
📒 Files selected for processing (9)
README.mdpackages/app/src/features/App/VaultCreator/index.tsxpackages/site/astro.config.mjspackages/site/src/content/docs/concepts/snapshots.mdpackages/site/src/content/docs/concepts/vault.mdpackages/site/src/content/docs/concepts/workspace.mdpackages/site/src/content/docs/guides/import-export.mdpackages/site/src/content/docs/guides/organizing-notes.mdpackages/site/src/content/docs/reference/encryption.md
✅ Files skipped from review due to trivial changes (6)
- packages/site/src/content/docs/concepts/snapshots.md
- packages/app/src/features/App/VaultCreator/index.tsx
- packages/site/src/content/docs/concepts/vault.md
- README.md
- packages/site/src/content/docs/concepts/workspace.md
- packages/site/src/content/docs/guides/organizing-notes.md
Sync behavior of click link in editor with latest app code
Cloudflare Pages DeploymentEvent Name: pull_request Wrangler Output⛅️ wrangler 4.100.0 🌎 Deploying... |
Cloudflare Pages DeploymentEvent Name: pull_request Wrangler Output⛅️ wrangler 4.100.0 🌎 Deploying... |
Cloudflare Pages DeploymentEvent Name: pull_request Wrangler Output⛅️ wrangler 4.100.0 🌎 Deploying... |
Cloudflare Pages DeploymentEvent Name: pull_request Wrangler Output⛅️ wrangler 4.100.0 🌎 Deploying... |
1 participant
Closes #325
Summary by CodeRabbit