Skip to content

Conversation

amotl
Copy link
Member

@amotl amotl commented Oct 5, 2025

About

"Going further" should perhaps just be moved into "First Steps" as it's basically an overview of the remaining TOC + some. Having it in the end seems very odd as that's after half the references in there.

Preview

References

@amotl amotl added refactoring Changing shape or layout, or moving content around. guidance Matters of layout, shape, and structure. labels Oct 5, 2025
Copy link

coderabbitai bot commented Oct 5, 2025

Walkthrough

Edits restructure the start documentation (replace card layout with sd-table rows, add a "Learn more" section, update toctree), remove the standalone "Going further" page, and update the performance index heading and add two new performance cards.

Changes

Cohort / File(s) Summary
Performance index updates
docs/performance/index.md
Heading case changed to "Performance guides"; adds two grid-item cards: "Allocation and Capacity" (sharding, scaling, storage guidance) and "Performance Handbook" (inserts/selects/optimization, latency/resource notes).
Start index restructuring
docs/start/index.md
Replaces grid-item cards with sd-table/sd-row/sd-item structure; adds a "Learn more" / start-going-further block; enumerates topics (Data modelling, Query capabilities, Drivers, Integrations, Reference manual, Sample applications, Database management, performance); updates toctree (adds application/index, keeps modelling/index, query/index, Ingesting data); minor label/whitespace tweaks.
Removal of 'Going further' page
docs/start/going-further.md
Deleted the "Going further" documentation page and its content.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • hammerhead
  • karynzv
  • surister

Poem

Thump-thump through the docs I hop with cheer,
Cards rearranged and tidy rows appear.
The burrow page has softly gone away,
New performance carrots brighten the day.
I nibble links and bounce—docs ready to play. 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly highlights the primary change of renaming the “Going further” section to “Learn more” on the index page, which aligns directly with the main refactoring in this pull request and is both clear and specific.
Description Check ✅ Passed The description clearly explains the rationale for relocating the “Going further” content into the “First Steps” area, references relevant discussion and provides a preview link, making it directly related to the documented changes and not off-topic.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch move-going-further

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 876e6ad and 384df94.

📒 Files selected for processing (2)
  • docs/performance/index.md (1 hunks)
  • docs/start/index.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/start/index.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: Build docs
🔇 Additional comments (1)
docs/performance/index.md (1)

3-39: Looks good – refreshed cards fit the grid nicely.

The reworded heading and added cards read well, and the toctree groupings keep the index concise. Nicely done.


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 marked this pull request as ready for review October 5, 2025 21:37
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the move-going-further branch from 876e6ad to 384df94 Compare October 5, 2025 22:37
@amotl amotl requested review from bmunkholm, kneth and surister October 5, 2025 22:38
@amotl amotl added the sanding-1200 Fine sanding. label Oct 6, 2025
@amotl amotl requested a review from karynzv October 6, 2025 02:34
Copy link
Contributor

@bmunkholm bmunkholm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking up that comment!
There are quite a few things I would like to change here, so let me get back on that.

@amotl
Copy link
Member Author

amotl commented Oct 6, 2025

I also would like to change a lot of things everywhere. This patch was just meant to quickly relocate the content so others can further curate it at their disposal. Maybe your ideas fit well into a subsequent patch?

@amotl amotl requested a review from bmunkholm October 6, 2025 10:08
Copy link
Contributor

@bmunkholm bmunkholm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually appreciate the speedyness! But I would keep current state than merging this as is. I have more concrete feedback, please allow me to get time for that.

@amotl
Copy link
Member Author

amotl commented Oct 6, 2025

It is really just a refactoring patch that barely changes any content. Maybe other feedback beyond that would be better suited as a dedicated ticket? You can easily add your feedback any time to improve particular pages per "Suggest improvement" workflow.

image

-- https://cratedb.com/docs/guide/start/
-- https://cratedb.com/docs/guide/start/going-further.html

@amotl amotl requested a review from bmunkholm October 6, 2025 10:22
@amotl amotl merged commit 19c40a2 into main Oct 6, 2025
3 checks passed
@amotl amotl deleted the move-going-further branch October 6, 2025 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
guidance Matters of layout, shape, and structure. refactoring Changing shape or layout, or moving content around. sanding-1200 Fine sanding.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants