Wording: Tame use of "This section..." #384
Merged
Conversation
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
WalkthroughDocumentation-wide editorial updates: many introductory sentences were rephrased, several plain intros converted into muted/styled blocks, and the ingest/ETL page gained categorized grid/cards. No code, examples, commands, or public API declarations were changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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)
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: 2
🧹 Nitpick comments (2)
docs/integrate/prefect/usage.md (1)
31-31: Restore a complete lead sentence.The new wording reads as a sentence fragment and drops the subject that framed the walkthrough. Please keep the sentence complete for clarity.
-A simple workflow that fetches data, applies a basic transformation, and loads it into CrateDB. +This example walks you through a simple workflow that fetches data, applies a basic transformation, and loads it into CrateDB.docs/connect/application.md (1)
54-56: Tighten the lead-in sentence grammarConsider rephrasing to “An overview of a few CLI programs, and how to use them for connecting to CrateDB clusters.” to avoid the awkward “overview about” construction while keeping the meaning intact.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (26)
docs/admin/clustering/logical-replication-setup.md(2 hunks)docs/connect/application.md(1 hunks)docs/connect/drivers.md(2 hunks)docs/connect/general.md(1 hunks)docs/connect/java.md(1 hunks)docs/connect/javascript.md(1 hunks)docs/connect/php.md(1 hunks)docs/connect/python.md(1 hunks)docs/connect/ruby.md(1 hunks)docs/feature/cursor/index.md(1 hunks)docs/feature/search/fts/analyzer.md(2 hunks)docs/feature/storage/index.md(2 hunks)docs/ingest/cdc/index.md(1 hunks)docs/ingest/etl/index.md(1 hunks)docs/ingest/index.md(1 hunks)docs/install/cloud/aws/index.rst(1 hunks)docs/install/container/index.rst(2 hunks)docs/install/container/kubernetes/kubernetes.rst(3 hunks)docs/install/index.rst(1 hunks)docs/install/tarball.rst(1 hunks)docs/integrate/mcp/community.md(1 hunks)docs/integrate/mcp/cratedb-mcp.md(1 hunks)docs/integrate/prefect/usage.md(1 hunks)docs/performance/inserts/index.md(1 hunks)docs/performance/optimization.md(6 hunks)docs/start/first-steps.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-10-06T16:40:16.322Z
Learnt from: amotl
PR: crate/cratedb-guide#0
File: :0-0
Timestamp: 2025-10-06T16:40:16.322Z
Learning: In the crate/cratedb-guide repository, documentation is organized by content type: files in `docs/feature/`, `docs/integrate/`, and `docs/ingest/` are reference material designed for quick access, while `docs/start/` contains learning path content. Reference material sections use top-right reference layouts for efficient navigation.
Applied to files:
docs/start/first-steps.md
📚 Learning: 2025-08-14T19:02:43.308Z
Learnt from: amotl
PR: crate/cratedb-guide#253
File: docs/integrate/mindsdb/index.md:21-33
Timestamp: 2025-08-14T19:02:43.308Z
Learning: In CrateDB integration documentation examples, default connection parameters (user="crate", password="", host="127.0.0.1") are intentionally used to provide working out-of-the-box examples for users with local CrateDB instances, rather than using placeholder values that require customization.
Applied to files:
docs/connect/general.md
📚 Learning: 2025-08-05T07:14:57.416Z
Learnt from: hammerhead
PR: crate/cratedb-guide#221
File: docs/connect/configure.md:58-66
Timestamp: 2025-08-05T07:14:57.416Z
Learning: In CrateDB connection strings, the user:password@ syntax is valid for HTTP Basic authentication on port 4200, but PostgreSQL JDBC drivers do not support this format and require credentials as query parameters (?user=<user>&password=<password>) instead.
Applied to files:
docs/connect/java.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 (2)
docs/feature/cursor/index.md (1)
24-24: Nice cleanup on the wording.Changing “same shape like” to “same shape as” improves the grammar without altering meaning.
docs/start/first-steps.md (1)
3-3: Reworded description reads smoothlyUpdated phrasing is concise and aligns with the PR goal of toning down “This section…” wording. Good catch.
bmunkholm
reviewed
Oct 8, 2025
bmunkholm
reviewed
Oct 8, 2025
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.
About
"This section [...]" was used a bit too often across the board. This patch attempts to tame it.