Reduce marketing msg in intro page and fix link to handbook. #424
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughUpdates Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/index.md(3 hunks)
🧰 Additional context used
🧠 Learnings (5)
📚 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/index.md
📚 Learning: 2025-08-23T15:15:18.717Z
Learnt from: amotl
PR: crate/cratedb-guide#235
File: docs/start/query/ai-integration.md:265-273
Timestamp: 2025-08-23T15:15:18.717Z
Learning: In CrateDB documentation, avoid using "data lake" terminology when describing CrateDB's role, as it can create misconceptions. Prefer "real-time analytics store" or similar terms that better reflect CrateDB's actual capabilities as a real-time analytics database.
Applied to files:
docs/index.md
📚 Learning: 2025-05-18T13:25:11.786Z
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
Applied to files:
docs/index.md
📚 Learning: 2025-09-25T19:31:54.320Z
Learnt from: bmunkholm
PR: crate/cratedb-guide#340
File: docs/home/index.md:84-97
Timestamp: 2025-09-25T19:31:54.320Z
Learning: In the CrateDB Guide docs (MyST), the CrateDB Cloud card on the homepage should link to `getting-started` using `:link-type: ref` instead of the previous `cloud:index` intersphinx target. This change was implemented in PR #340 to direct users to the getting started section rather than directly to the Cloud documentation.
Applied to files:
docs/index.md
📚 Learning: 2025-10-08T01:34:18.867Z
Learnt from: amotl
PR: crate/cratedb-guide#385
File: docs/connect/java.md:48-51
Timestamp: 2025-10-08T01:34:18.867Z
Learning: CrateDB JDBC driver uses the `jdbc:crate://` protocol scheme but communicates via the PostgreSQL wire protocol on port 5432, just like the PostgreSQL JDBC driver (`jdbc:postgresql://`). Do not confuse the `jdbc:crate://` scheme with other protocol schemes like `crate://` (used by SQLAlchemy dialect for CrateDB) or assume it uses the HTTP endpoint on port 4200.
Applied to files:
docs/index.md
🪛 LanguageTool
docs/index.md
[grammar] ~26-~26: Use a hyphen to join words.
Context: ...oduct overview] to learn more about high level features and use cases. This docu...
(QB_NEW_EN_HYPHEN)
⏰ 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/index.md (2)
20-29: Well-executed reduction of marketing content with practical refocus.The header update now includes AI capabilities (line 20–21), and the intro text (lines 28–29) clearly articulates the documentation's purpose—getting started, exploring in practice, and operating in detail. The addition of the Product overview link (line 26) provides a practical exit point for users seeking broader business context without inflating the introduction with marketing narrative. This aligns well with the PR objective to refocus on "how-to" content.
75-82: Handbook link target resolves correctly.Verification confirms the handbook reference is properly configured:
- MyST reference target
(handbook)=exists at line 1 ofdocs/handbook/index.mdhandbook/indexis indexed in the toctree (line 15 ofdocs/index.md)- The
:link: handbookwith:link-type: refwill resolve without issuesNo further action needed on this change.
Summary of the changes / Why this is an improvement
The marketing messaging was verbose and mostly duplicates whats already in the product pages, but at the same time don't cover as well. Let's keep docs more focused on the practical "how-to".
Related issue: https://github.com/crate/tech-content/issues/173. Still need to consider how much of the learning links should be here and how much should be moved to the Getting Started section now that that exists.
Preview
https://cratedb-guide--424.org.readthedocs.build/