Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Oct 29, 2025

@amotl amotl added reorganize Moving content around, inside and between other systems. guidance Matters of layout, shape, and structure. labels Oct 29, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 29, 2025

Warning

Rate limit exceeded

@amotl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 35 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 4ed446d and 52c1ba1.

📒 Files selected for processing (4)
  • docs/feature/index.md (3 hunks)
  • docs/handbook/index.md (1 hunks)
  • docs/solution/index.md (2 hunks)
  • docs/start/video/index.md (1 hunks)

Walkthrough

This PR restructures multiple documentation pages: adds Admin Tools and Videos pages, creates a Feature Highlights page, refactors landing/handbook/start/ingest/solution/tutorial/topic indices, updates grid/card layouts and cross-references, and removes the Database IDEs section from connect/application.md.

Changes

Cohort / File(s) Summary
Connection & Admin Tools Restructuring
docs/connect/application.md
Adds an Admin Tools section with grid-item cards for CrateDB Admin UI and CrateDB Shell, converts Admin UI label to internal cross-reference, adds access guidance for local/cloud, removes the Database IDEs section (DataGrip, DBeaver).
New Feature Highlights Documentation
docs/feature/highlights.md
New highlights page with multiple article blocks describing document store/JSON, unified search (BM25/vector), advanced querying/time-series, solutions/use-cases, and feature categories.
Feature Index Update
docs/feature/index.md
Adds a toctree and renames rubric to "Related sections"; refocuses content toward connectivity and integration and removes the previous Highlights grid.
Main Landing / Navigation
docs/index.md
Reworks landing to a Start/Connect/Integrations flow, replaces/renames many cards and imagery, and restructures Learn/feature navigation.
Handbook Restructuring
docs/handbook/index.md
Reorganizes grids/cards (layout and sizes), increases icon sizing, renames sections (e.g., Highlights → Best practice guides), and expands ingestion/administration/performance card content.
Start / Examples / Video
docs/start/index.md, docs/start/application/index.md, docs/start/video/index.md
Adds video index page with embeds and playlists; expands Learn more with Handbook/Academy/Community Portal cards; updates guestbook wording and adds "Assorted examples" card linking to GitHub examples.
Solution & Ingestion Restructuring
docs/solution/index.md, docs/ingest/index.md
Replaces Explanations with Overview, changes time-series blocks to material-outlined styling, adds "Using CrateDB" / "Using CrateDB Cloud" / "Using external systems" sections, updates ETL/CDC/Telemetry links and COPY FROM references.
Topic & Tutorial Updates
docs/topic/index.md, docs/tutorial/index.md
Adds a categories directive to topic index; adds a Courses rubric and Academy link card in tutorial index, removing the previous Academy card block.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

  • Areas needing extra attention:
    • Verify internal cross-references (e.g., {ref} targets like crate-admin-ui:index, sql-copy-from, cluster-import)
    • Validate toctree additions (video/index, etl/index, cdc/index, telemetry/index) for navigation conflicts
    • Confirm removal of Database IDEs doesn't leave broken links or orphaned references
    • Check visual/grid consistency (icon sizing and card layout changes)

Possibly related PRs

Suggested reviewers

  • kneth
  • surister
  • karynzv
  • bmunkholm

Poem

🐰 Hopped the docs to tidy the view,
Cards rearranged and a highlights stew,
Videos tucked in, Admin Tools in sight,
Start, Connect, Integrate—everything's light,
A nibble of change, and the guide feels new.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
Title Check ❓ Inconclusive The PR title "Chore: Clean up and declutter" uses somewhat generic and vague terminology that lacks specificity. While the title does relate to the changeset (which involves reorganizing layouts and reducing cards across multiple documentation files), terms like "clean up" and "declutter" don't clearly convey the specific nature or scope of the changes. A reader scanning the git history would have limited insight into what was actually modified beyond a general sense of reorganization. The PR description provides more concrete details (improving guidance, cleaning layouts, using fewer cards across Welcome, Handbook, Features, Ingest, and Solutions sections), but the title itself remains relatively non-descriptive. Consider using a more specific and descriptive title that captures the main intent, such as "Documentation: Reorganize layouts and consolidate card-based sections" or "Documentation: Restructure feature, ingest, and handbook pages to improve guidance and reduce complexity." This would provide clearer context about what changed without requiring readers to check the full description.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed The PR description is directly related to the changeset and provides meaningful context about the modifications. It clearly articulates the "What" (improve guidance, clean up layouts, use fewer cards), the "Where" (Welcome, Handbook, Features, Ingest, Solutions), and provides preview build links for verification. The description also references GH-227, linking to a related issue. This level of detail is sufficient to understand the purpose and scope of the changes, even if the title itself is generic.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@amotl amotl added the sanding-1200 Fine sanding. label Oct 29, 2025
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl added the cross linking Linking to different locations of the documentation. label Oct 29, 2025
@amotl amotl force-pushed the less-cards branch 2 times, most recently from 2e7be39 to 4ed446d Compare October 29, 2025 05:28
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl requested a review from seut October 29, 2025 06:14
@amotl amotl merged commit 9252063 into main Oct 29, 2025
3 checks passed
@amotl amotl deleted the less-cards branch October 29, 2025 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cross linking Linking to different locations of the documentation. guidance Matters of layout, shape, and structure. reorganize Moving content around, inside and between other systems. sanding-1200 Fine sanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants