Intersphinx: Fix lost index link target

[amotl]

About

Link target labels must be placed above headlines to make them render well into HTML link anchors like <span id="index"></span>.

In this case, a recent refactoring displaced the link target label away from its headline. This causes downstream link checkers to fail when trying to resolve the link reference.

projects: line 22 broken
https://cratedb.com/docs/guide/index.html#index - Anchor 'index' not found

References

• https://github.com/crate/crate-docs-theme/actions/runs/18753640989/job/53499716469?pr=640#step:7:703

[coderabbitai]

Walkthrough

The pull request reorganizes and enhances the main documentation index file by consolidating the top-level heading to the start, removing a duplicate, and updating the introductory paragraph to emphasize core platform benefits including SQL power, NoSQL scalability, and modern data platform flexibility.

Changes

Cohort / File(s)	Summary
Documentation index restructuring docs/index.md	Moved top-level "Welcome to CrateDB" heading to the start of the file, removed duplicate occurrence, and updated introductory paragraph with emphasized benefits highlighting SQL, NoSQL scalability, and platform flexibility.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• Index and Topics: Improve guidance #369: Updates docs/index.md index guidance and layout structure.
• Reduce marketing msg in intro page and fix link to handbook. #424: Modifies docs/index.md introductory messaging and header content.
• Refine "home" and "connect" entry point pages #237: Applies broader restructuring changes to docs/index.md.

Suggested reviewers

• kneth
• surister
• bmunkholm

Poem

🐰 A hop and a bound through the welcome page,
We've tidied the headers and centered the stage,
With SQL and NoSQL in harmonious dance,
The docs now invite with a welcoming glance! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "Intersphinx: Fix lost index link target" is clearly related to the main change in the changeset. The raw summary shows modifications to docs/index.md including restructuring the top-level heading by adding it at the start and removing a duplicate, along with content updates. According to the PR description, these changes address a displaced link target label that was causing link checker failures. The title accurately captures the primary objective—fixing a missing/displaced link anchor in the Sphinx documentation—which aligns with the file-level changes described.
Description Check	✅ Passed	The pull request description is clearly related to the changeset. It explains that link target labels must be positioned above headlines in Sphinx documentation for proper HTML anchor rendering, describes how a recent refactoring displaced the link target label, and references the specific broken link issue affecting the documentation. These explanations directly correspond to the structural changes made in docs/index.md, providing meaningful context for why the heading and content reorganization was necessary.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch intersphinx-fix-index

---

📜 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 032746a and f5d24cd.

📒 Files selected for processing (1)

• docs/index.md (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

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.

📚 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

⏰ 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)

1-4: Excellent fix for the broken intersphinx anchor.

The (index)= label is now correctly positioned directly above the # Welcome to CrateDB heading, which resolves the "Anchor 'index' not found" error. This placement ensures Sphinx generates the proper HTML anchor (<span id="index"></span>) that downstream link checkers and intersphinx references can resolve.

The consolidation of the heading to the top of the file and removal of the duplicate—combined with the corrected label placement—restores the intended link target behavior.

---

20-24: Strong enhancement to the value proposition.

The expanded introductory paragraph now emphasizes CrateDB's core strengths: the "power of SQL," "scalability of NoSQL," and "flexibility of a modern data platform." This messaging is more compelling and better articulates the positioning than the previous version, making it clearer to new visitors what makes CrateDB distinctive.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}