Skip to content

Conversation

@bmunkholm
Copy link
Contributor

@bmunkholm bmunkholm commented Sep 25, 2025

Summary of the changes / Why this is an improvement

There is a wrong link to Cloud Quick Start that needs immediate fixing.
A few other adjustments were made.

Preview

https://cratedb-guide--340.org.readthedocs.build/home/

@bmunkholm bmunkholm requested a review from amotl September 25, 2025 12:24
@coderabbitai
Copy link

coderabbitai bot commented Sep 25, 2025

Walkthrough

Homepage docs/home/index.md content was revised: Get Started card state/icon, link target, CTA, and copy updated; Learn/Integrations and Resources sections were consolidated and reframed; Examples, Samples, and Videos cards added/renamed; multiple small copy, alt-text, heading, and formatting edits applied.

Changes

Cohort / File(s) Summary of Changes
Docs homepage content updates
docs/home/index.md
Updated Get Started card (state/icon -> not_started, link -> first-steps, CTA text and heading copy); merged and reframed Learn/Integrations content into a single Integrations entry; added Examples & Samples cards; renamed/rephrased CrateDB Videos card and changed playlist/attribution copy; many minor copy, alt-text, heading, and formatting tweaks.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

maintenance, enhancement, cross linking

Suggested reviewers

  • hammerhead
  • karynzv

Poem

I twitch my nose and tidy the way,
Cards hop into place — bright new day.
"Get started" beckons, integrations sing,
Videos, examples — fresh links to bring.
A rabbit bows — docs sprout a spring 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title “Update Overview page” is concise but too generic because it does not specify the primary change of fixing the wrong Cloud Quick Start link or highlight the key adjustments made to the Overview page. Consider revising the title to reference the main fix, for example “Fix wrong Cloud Quick Start link on Overview page” to clearly convey the purpose of the update.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed The description explicitly states that it corrects a wrong link to Cloud Quick Start, mentions additional adjustments, and includes a preview link, all of which align with the documented changes in the Overview page.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bm/update-Overview

📜 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 7c09f8e and 9ae28cf.

📒 Files selected for processing (1)
  • docs/home/index.md (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/home/index.md

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.

coderabbitai[bot]

This comment was marked as resolved.

@bmunkholm bmunkholm marked this pull request as draft September 25, 2025 12:42
@bmunkholm
Copy link
Contributor Author

Build of docs is failing. But it's the same if no changes are done to the main branch.

@bmunkholm bmunkholm marked this pull request as ready for review September 25, 2025 13:32
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b28725f and bbaabd3.

📒 Files selected for processing (1)
  • docs/home/index.md (3 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#234
File: docs/home/index.md:47-50
Timestamp: 2025-08-08T16:50:14.965Z
Learning: In the CrateDB Guide docs (MyST), the correct intersphinx target for the CrateDB Cloud documentation homepage is `cloud:index` (not `cloud:docs-index` or `cloud-docs-index`). Use `:link: cloud:index` on cards/links. The `cloud` mapping is inherited via crate-docs-theme.
📚 Learning: 2025-08-08T16:50:14.965Z
Learnt from: amotl
PR: crate/cratedb-guide#234
File: docs/home/index.md:47-50
Timestamp: 2025-08-08T16:50:14.965Z
Learning: In the CrateDB Guide docs (MyST), the correct intersphinx target for the CrateDB Cloud documentation homepage is `cloud:index` (not `cloud:docs-index` or `cloud-docs-index`). Use `:link: cloud:index` on cards/links. The `cloud` mapping is inherited via crate-docs-theme.

Applied to files:

  • docs/home/index.md

@amotl amotl mentioned this pull request Sep 28, 2025
@bmunkholm
Copy link
Contributor Author

bmunkholm commented Sep 29, 2025

@amotl Do you know why the linkcheck fails here:

( home/index: line 93) broken first-steps -

The link works fine (at least in preview).

@bmunkholm bmunkholm merged commit 6b6e055 into main Sep 29, 2025
2 of 3 checks passed
@bmunkholm bmunkholm deleted the bm/update-Overview branch September 29, 2025 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants