Update index.md - ignore #246
Conversation
WalkthroughUpdated the H1 header in docs/home/index.md from “Welcome to CrateDB” to “Welcome to CrateDB!”. No other changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![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/home/index.md(1 hunks)
⏰ 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/home/index.md (1)
6-6: LGTM — simple punctuation tweak to H1No functional changes to content; the exclamation mark reads fine for a landing page headline.
|
|
||
| # Welcome to CrateDB | ||
| # Welcome to CrateDB! | ||
|
|
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Stabilize anchor slug and verify no inbound links to the old H1
Adding punctuation can change generated heading slugs/anchors, potentially breaking deep links. Recommend adding a stable MyST/Sphinx label and checking for any inbound links to the previous slug.
Apply this diff to add a stable label:
-# Welcome to CrateDB!
+(home)=
+# Welcome to CrateDB!
Run this script to detect any inbound links to the old slug or title:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Look for markdown-style deep links that may reference the old H1 slug
echo "Searching for possible deep links to the old H1 anchor..."
rg -n --no-messages $'#welcome-to-cratedb(\\b|[^a-zA-Z0-9_-])' || true
# Also search for occurrences of the old title text used in links
echo "Searching for links/text referencing 'Welcome to CrateDB'..."
rg -n --no-messages $'\\[.*\\]\\([^)]*#welcome-to-cratedb[^)]*\\)|Welcome to CrateDB\\b' || trueLength of output: 479
Stabilize H1 anchor in docs/home/index.md
No inbound deep-links or references to #welcome-to-cratedb were found outside of the H1 itself. To lock this slug and avoid future breakage if the title text changes, please add a stable MyST label above the heading:
Locations to update:
- docs/home/index.md (around line 5)
Apply this patch:
docs/home/index.md
@@ -4,7 +4,8 @@
+(home)=
# Welcome to CrateDB!
The premier distributed SQL database for time-series, search, and transactions.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Welcome to CrateDB | |
| # Welcome to CrateDB! | |
| (home)= | |
| # Welcome to CrateDB! | |
| The premier distributed SQL database for time-series, search, and transactions. |
🤖 Prompt for AI Agents
In docs/home/index.md around lines 5 to 7, the H1 "Welcome to CrateDB!" needs a
stable MyST label so the generated anchor (#welcome-to-cratedb) remains constant
if the heading text changes; add a MyST label directly above the H1 using the
format `:label: welcome-to-cratedb` (or `.. _welcome-to-cratedb:` depending on
project convention) so the slug is locked, then keep the existing H1 unchanged.
1 participant
Summary of the changes / Why this is an improvement
test
Checklist