Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Oct 7, 2025

About

Improve "What's inside" conveyance in README.

Details

Naming things: s/Guide/Handbook/

References

@coderabbitai
Copy link

coderabbitai bot commented Oct 7, 2025

Walkthrough

Rebranded documentation from “CrateDB Guide” to “CrateDB Handbook,” updated navigation labels and links to reflect “Learning path” and “Reference material,” adjusted directory naming in text, refreshed external/internal references, revised badges, and made minor stylistic edits and additions in the contributing and metadata sections.

Changes

Cohort / File(s) Change Summary
Docs rebranding and navigation updates
README.md
Renamed guide to handbook, replaced navigation labels to “Learning path” and “Reference material,” updated internal/external links (e.g., Reference Manual, Authoring Guide path), adjusted described folder structure (howto, tutorial, admin, solution), refreshed CI badges, and minor wording/formatting and contributing updates.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

guidance, refactoring, maintenance

Suggested reviewers

  • bmunkholm
  • kneth
  • surister

Poem

I thump my paws: a handbook’s born,
Paths to learn and refs to adorn.
Links hop neat in tidy rows,
Badges gleam where CI glows.
In burrows of docs, I nibble and cheer—
Guide to handbook, crystal clear! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly identifies that the README is being updated to reflect the new section styles “learning path” versus “reference material,” which aligns with a key aspect of the changeset and is neither vague nor off-topic. Although it does not explicitly mention the rename from “Guide” to “Handbook,” it still captures a substantive part of the update.
Description Check ✅ Passed The description succinctly explains that the pull request improves the “What’s inside” section of the README and renames occurrences of “Guide” to “Handbook,” which directly corresponds to the documented changes.
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 readme-update-layout

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 7, 2025 20:58
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl added guidance Matters of layout, shape, and structure. maintenance C'est la vie. labels Oct 7, 2025
@amotl amotl requested review from bmunkholm, kneth and surister October 7, 2025 21:03
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 reflecting what we currently have.
I foresee updates to this, but it's great to reflect current state.

@amotl amotl merged commit b4109d8 into main Oct 8, 2025
3 checks passed
@amotl amotl deleted the readme-update-layout branch October 8, 2025 22:45
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. maintenance C'est la vie.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants