Add screenshots placeholder and adjust styles across documentation and components#4
Merged
Conversation
…d components - Updated various documentation files to include placeholders for upcoming screenshots. - Adjusted font sizes in Hero and TableOfContents components for better readability. - Implemented a sidebar resizer feature for improved user experience in PageFrame component. - Enhanced styling for action buttons and content areas to ensure consistency and accessibility. - Added media queries to maintain layout integrity across different screen sizes.
|
Warning Review limit reached
More reviews will be available in 28 minutes and 25 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (11)
📝 WalkthroughWalkthroughUpdated site configuration to add Expressive Code config and lastUpdated, reorganized Starlight sidebar, suppressed a Rollup warning, standardized “Screenshots coming” notes across many docs, added API Quickstart and S3 usage pages, and implemented TOC action buttons plus sidebar/TOC resize and typography/CSS updates. ChangesSite Configuration Setup
Documentation Content Updates
UI Component and Styling Enhancements
🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested reviewers:
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (1)
src/content/docs/public-cloud/storage/object-storage/s3-usage.md (1)
85-87: ⚡ Quick winConvert the inline
:::tip ... :::callout to block form (consistency/readability).The
... compatibility. :::inline-close style is already used elsewhere in the docs, so this is mainly a formatting consistency tweak rather than a parsing fix.Suggested fix
-:::tip Use `forcePathStyle: true` (Node.js) when working with Ceph-backed S3 to ensure -compatibility. ::: +:::tip +Use `forcePathStyle: true` (Node.js) when working with Ceph-backed S3 to ensure compatibility. +:::🤖 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 `@src/content/docs/public-cloud/storage/object-storage/s3-usage.md` around lines 85 - 87, Replace the inline callout usage of :::tip Use `forcePathStyle: true` (Node.js) when working with Ceph-backed S3 to ensure compatibility. ::: with a proper block callout so it renders as a standalone tip block (i.e., convert the inline `:::tip ... :::` sequence into the block form that begins with `:::tip` on its own line, the content on following lines, and a closing `:::` on its own line) to match the other callouts in the docs and improve readability.
🤖 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 `@astro.config.mjs`:
- Around line 21-24: The "last updated" badge code in TableOfContents.astro
should read the Starlight-provided value from
Astro.locals.starlightRoute.lastUpdated (falling back to entry.data.lastUpdated
if desired) because setting lastUpdated: true does not populate
entry.data.lastUpdated; update the badge rendering logic in
TableOfContents.astro to use Astro.locals.starlightRoute.lastUpdated (or use
Astro.locals.starlightRoute.lastUpdated ?? entry.data.lastUpdated) wherever the
component currently checks entry.data.lastUpdated so the badge appears
correctly.
In `@src/content/docs/public-cloud/compute/settings/change-os.md`:
- Around line 11-13: Replace the malformed inline admonition that begins
"Changing the OS will erase all existing data and configurations on the VM. Back
up critical data before proceeding. Delete snapshots and backups before changing
the OS." with a proper block-style warning admonition so it renders correctly;
locate the paragraph containing that exact warning text in change-os.md and wrap
it using the standard warning block syntax used across the docs (a dedicated
warning block with a clear title and the same warning copy), ensuring the
content is a single contiguous block so the admonition renderer recognizes it.
In `@src/content/docs/public-cloud/storage/object-storage/create-bucket.md`:
- Around line 41-43: The Starlight aside for "Object Locking" has its closing
delimiter placed inline ("storage costs. :::"), which breaks parsing; edit the
aside block so the closing triple-colon appears alone on its own line (i.e., end
the paragraph with "storage costs." then put ":::” on the next line) to restore
proper aside parsing for the note text.
In `@src/overrides/PageFrame.astro`:
- Line 100: Wrap all localStorage access in PageFrame.astro (both setItem and
getItem for STORAGE_KEY) with try/catch to avoid exceptions in private browsing
or disabled storage; specifically, around the call that sets STORAGE_KEY
(String(currentWidthPx)) and the corresponding getItem usage ensure errors are
caught and ignored or fallback values are used so the resize feature doesn't
break, and log or silently handle the error inside the catch block.
In `@src/overrides/TableOfContents.astro`:
- Line 155: The copy handlers call navigator.clipboard.writeText(...) directly
which will throw in non-secure or unsupported environments; update both the
handler containing await navigator.clipboard.writeText(combined) and the
markdown copy handler referenced near the second occurrence to first check for
availability (e.g. verify navigator.clipboard and navigator.clipboard.writeText
exist) and wrap the writeText call in a try/catch so failures are handled
gracefully (fall back to selection/execCommand or show a user-friendly
error/toast) instead of breaking the feature.
- Around line 29-30: The edit link currently uses raw filePath built from
entry.id and can break for special characters; update the code so the path is
URL-encoded before interpolation into editUrl (use entry.id to produce an
encodedPath by splitting on '/' and applying encodeURIComponent to each segment,
then joining with '/'), then build editUrl as
`${DOCS_REPO}/edit/main/${encodedPath}` (references:
filePath/editUrl/entry.id/DOCS_REPO).
---
Nitpick comments:
In `@src/content/docs/public-cloud/storage/object-storage/s3-usage.md`:
- Around line 85-87: Replace the inline callout usage of :::tip Use
`forcePathStyle: true` (Node.js) when working with Ceph-backed S3 to ensure
compatibility. ::: with a proper block callout so it renders as a standalone tip
block (i.e., convert the inline `:::tip ... :::` sequence into the block form
that begins with `:::tip` on its own line, the content on following lines, and a
closing `:::` on its own line) to match the other callouts in the docs and
improve readability.
🪄 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: 633cd232-75ee-43c3-bb17-17bc3a97e94b
📒 Files selected for processing (46)
astro.config.mjsec.config.mjssrc/content/docs/public-cloud/affinity-groups/index.mdsrc/content/docs/public-cloud/auto-scaling/index.mdsrc/content/docs/public-cloud/backups-snapshots/backups.mdsrc/content/docs/public-cloud/backups-snapshots/vm-snapshots.mdsrc/content/docs/public-cloud/compute/activity-logs.mdsrc/content/docs/public-cloud/compute/connect-rdp.mdsrc/content/docs/public-cloud/compute/connect-ssh.mdsrc/content/docs/public-cloud/compute/console-access.mdsrc/content/docs/public-cloud/compute/create-instance.mdsrc/content/docs/public-cloud/compute/instance-overview.mdsrc/content/docs/public-cloud/compute/power-management.mdsrc/content/docs/public-cloud/compute/settings/block-storage.mdsrc/content/docs/public-cloud/compute/settings/change-os.mdsrc/content/docs/public-cloud/compute/settings/firewall.mdsrc/content/docs/public-cloud/compute/settings/networks.mdsrc/content/docs/public-cloud/compute/settings/port-forwarding.mdsrc/content/docs/public-cloud/compute/settings/resize-plan.mdsrc/content/docs/public-cloud/compute/settings/ssh-keys.mdsrc/content/docs/public-cloud/compute/settings/startup-scripts.mdsrc/content/docs/public-cloud/dns/domains.mdsrc/content/docs/public-cloud/getting-started/account-signup.mdsrc/content/docs/public-cloud/getting-started/profile-setup.mdsrc/content/docs/public-cloud/kubernetes/cluster-overview.mdsrc/content/docs/public-cloud/kubernetes/create-cluster.mdsrc/content/docs/public-cloud/load-balancer/index.mdsrc/content/docs/public-cloud/networking/public-network/create.mdsrc/content/docs/public-cloud/networking/public-network/egress-rules.mdsrc/content/docs/public-cloud/networking/public-network/overview.mdsrc/content/docs/public-cloud/networking/public-network/public-ips.mdsrc/content/docs/public-cloud/networking/vpc/add-subnet.mdsrc/content/docs/public-cloud/networking/vpc/create-vpc.mdsrc/content/docs/public-cloud/networking/vpc/network-acls.mdsrc/content/docs/public-cloud/networking/vpc/public-ips.mdsrc/content/docs/public-cloud/networking/vpc/site-vpn.mdsrc/content/docs/public-cloud/networking/vpc/vpn-users.mdsrc/content/docs/public-cloud/storage/block-storage/create-volume.mdsrc/content/docs/public-cloud/storage/block-storage/snapshots.mdsrc/content/docs/public-cloud/storage/object-storage/access-keys.mdsrc/content/docs/public-cloud/storage/object-storage/create-bucket.mdsrc/content/docs/public-cloud/storage/object-storage/s3-usage.mdsrc/overrides/Hero.astrosrc/overrides/PageFrame.astrosrc/overrides/TableOfContents.astrosrc/styles/custom.css
💤 Files with no reviewable changes (2)
- src/content/docs/public-cloud/compute/settings/startup-scripts.md
- src/content/docs/public-cloud/compute/activity-logs.md
- Updated API domains table for clarity, changing "Instances" to "Virtual Machines". - Enhanced caution messages in the Change OS, Resize Plan, and SSH Keys documentation to improve user awareness of data loss risks. - Expanded the DNS domains documentation to provide a comprehensive guide on managing DNS, including registrar-specific instructions and propagation verification. - Introduced a new S3 API Usage guide with examples in multiple programming languages, ensuring users can effectively utilize ZSoftly's S3-compatible object storage. - Implemented a resizable layout for the documentation interface, allowing users to adjust sidebar and TOC widths for improved navigation. - Updated CSS styles to support the new resizable layout and ensure a responsive design across different screen sizes.
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)
src/overrides/PageFrame.astro (1)
59-77:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUpdate ARIA value semantics for keyboard-resizable
role="separator"handles
#sidebar-resizerand#toc-resizerare focusablerole="separator"elements, but they don’t definearia-valuemin/aria-valuemax/aria-valuenow, andinitHandleonly updates the CSS custom property (viaapply()triggered by thekeydownhandler) without setting any ARIA value attributes. Initializearia-valuemin/aria-valuemaxfrommin/max, and setaria-valuenowwheneverapply()clamps/updates the current size, for both handles.🤖 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 `@src/overrides/PageFrame.astro` around lines 59 - 77, The separator handles `#sidebar-resizer` and `#toc-resizer` must expose ARIA value semantics: in initHandle (the function that wires up each handle) set aria-valuemin and aria-valuemax from the handle's min and max values, and initialize aria-valuenow to the starting size; then update aria-valuenow whenever apply() clamps or updates the current size (including inside the keydown handler that triggers apply()), ensuring both handles always reflect the current numeric size via aria-valuenow while keeping aria-valuemin/aria-valuemax in sync with min/max.
🤖 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 `@src/content/docs/public-cloud/storage/object-storage/s3-usage.mdx`:
- Around line 10-11: The sentence "ZSoftly object storage is S3-compatible
(backed by Ceph RGW). Any tool or SDK that supports S3 works with it." reveals
internal backend details; remove the parenthetical "backed by Ceph RGW" and make
the statement vendor-neutral — e.g., change it to "ZSoftly object storage is
S3-compatible. Any tool or SDK that supports S3 works with it." Ensure the edit
is applied where that exact sentence appears in
src/content/docs/public-cloud/storage/object-storage/s3-usage.mdx.
---
Outside diff comments:
In `@src/overrides/PageFrame.astro`:
- Around line 59-77: The separator handles `#sidebar-resizer` and `#toc-resizer`
must expose ARIA value semantics: in initHandle (the function that wires up each
handle) set aria-valuemin and aria-valuemax from the handle's min and max
values, and initialize aria-valuenow to the starting size; then update
aria-valuenow whenever apply() clamps or updates the current size (including
inside the keydown handler that triggers apply()), ensuring both handles always
reflect the current numeric size via aria-valuenow while keeping
aria-valuemin/aria-valuemax in sync with min/max.
🪄 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: 605c0afe-4329-49a7-98d6-f079cb51cd9f
📒 Files selected for processing (16)
src/content/docs/index.mdxsrc/content/docs/public-cloud/api/authentication.mdsrc/content/docs/public-cloud/api/quickstart.mdsrc/content/docs/public-cloud/api/quickstart.mdxsrc/content/docs/public-cloud/api/reference.mdsrc/content/docs/public-cloud/compute/settings/change-os.mdsrc/content/docs/public-cloud/compute/settings/resize-plan.mdsrc/content/docs/public-cloud/compute/settings/ssh-keys.mdsrc/content/docs/public-cloud/dns/domains.mdsrc/content/docs/public-cloud/getting-started/introduction.mdsrc/content/docs/public-cloud/storage/object-storage/access-keys.mdsrc/content/docs/public-cloud/storage/object-storage/create-bucket.mdsrc/content/docs/public-cloud/storage/object-storage/s3-usage.mdsrc/content/docs/public-cloud/storage/object-storage/s3-usage.mdxsrc/overrides/PageFrame.astrosrc/styles/custom.css
💤 Files with no reviewable changes (2)
- src/content/docs/public-cloud/api/quickstart.md
- src/content/docs/public-cloud/storage/object-storage/s3-usage.md
✅ Files skipped from review due to trivial changes (5)
- src/content/docs/public-cloud/getting-started/introduction.md
- src/content/docs/public-cloud/api/reference.md
- src/content/docs/public-cloud/storage/object-storage/access-keys.md
- src/content/docs/public-cloud/storage/object-storage/create-bucket.md
- src/content/docs/public-cloud/compute/settings/change-os.md
🚧 Files skipped from review as they are similar to previous changes (2)
- src/content/docs/public-cloud/compute/settings/ssh-keys.md
- src/styles/custom.css
The Swagger UI links rendered the raw endpoint URL as their link text, so "ceph" and "nimbo" still showed in the page body. Replace the link text with "Open the Swagger UI" (the bold label already names each API) while keeping the real endpoint hrefs, which cannot change without breaking the links.
ditahkk
force-pushed
the
issues/keep-2ndDomain
branch
from
8654921 to
d02d408
Compare
ditahm6
approved these changes
Jun 1, 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
2 participants
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.
What changed
Why
Checklist
pnpm fmt && pnpm lint && pnpm typecheck && pnpm buildall pass:::note Screenshot pending:::if unavailableSummary by CodeRabbit
New Features
Documentation
Style