Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Nov 2, 2025

What the title says.

@amotl amotl added the maintenance C'est la vie. label Nov 2, 2025
@coderabbitai
Copy link

coderabbitai bot commented Nov 2, 2025

Walkthrough

Documentation updated: the "Related reading" subsection in docs/admin/scale/expand.md was removed and replaced with a "See also" subsection pointing to internal docs for multi-node-setup, clustering, and storage-consistency.

Changes

Cohort / File(s) Change Summary
Documentation navigation
docs/admin/scale/expand.md
Removed external "Related reading" subsection; added internal "See also" subsection linking to multi-node-setup, clustering, and storage-consistency.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single doc file; link text/section rename only.

Possibly related PRs

Suggested labels

cross linking, reorganize

Suggested reviewers

  • kneth
  • surister
  • bmunkholm

Poem

🐰 I hopped through links with tiny feet,
Swapped old references for paths more neat.
From "Related" to "See also" I go,
Guiding readers in a tidy row. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
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.
Description Check ❓ Inconclusive The description "What the title says" is minimal and provides no independent information about the changeset. While it technically references the title (which is related to the changes), it does not convey any meaningful details about what was actually changed. The description essentially defers all explanation to the title without providing any substantive description of the PR's purpose, scope, or implementation, making it effectively non-descriptive.
✅ Passed checks (1 passed)
Check name Status Explanation
Title Check ✅ Passed The title "Chore: Fix broken links after reorganizations" is directly related to the changeset, which involves updating and reorganizing reference links in the documentation. Specifically, the PR removes a "Related reading" subsection and adds a new "See also" subsection with updated references in docs/admin/scale/expand.md. The title clearly communicates the main change (fixing links after reorganizations) and is concise and specific enough for a teammate to understand the primary purpose of the changeset when scanning history.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-broken-links-1102

📜 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 2e19fa5 and e48b86e.

📒 Files selected for processing (1)
  • docs/admin/scale/expand.md (1 hunks)
🧰 Additional context used
🧠 Learnings (10)
📓 Common learnings
Learnt from: bmunkholm
Repo: crate/cratedb-guide PR: 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-08-09T11:00:03.578Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 236
File: docs/index.md:312-316
Timestamp: 2025-08-09T11:00:03.578Z
Learning: In the CrateDB Guide documentation, locally stale references (such as `(reference-architectures)=`, `(domain)=`, and similar anchor labels) should be retained even when they appear unused within the repository, as external projects might still reference them. This ensures backward compatibility for external documentation and projects.

Applied to files:

  • docs/admin/scale/expand.md
📚 Learning: 2025-10-10T17:58:26.545Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 395
File: docs/install/cloud/azure/terraform.md:108-127
Timestamp: 2025-10-10T17:58:26.545Z
Learning: In the crate/cratedb-guide repository, during documentation format conversions (e.g., from reStructuredText to MyST/Markdown), markdownlint warnings such as MD053 (unused reference-style links) should be ignored and not flagged as issues.

Applied to files:

  • docs/admin/scale/expand.md
📚 Learning: 2025-09-25T19:31:54.320Z
Learnt from: bmunkholm
Repo: crate/cratedb-guide PR: 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/admin/scale/expand.md
📚 Learning: 2025-08-26T21:28:48.295Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 235
File: docs/start/query/performance.md:10-16
Timestamp: 2025-08-26T21:28:48.295Z
Learning: When reviewing Sphinx documentation that uses intersphinx references (indicated by prefixes like `crate-reference:`), these references point to external documentation and won't be found by text searches within the current repository. They are validated during the Sphinx build process, not by static analysis of the repository content.

Applied to files:

  • docs/admin/scale/expand.md
📚 Learning: 2025-08-10T17:59:43.508Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 241
File: docs/integrate/grafana/index.md:37-46
Timestamp: 2025-08-10T17:59:43.508Z
Learning: When verifying cross-references in Sphinx-based documentation, search for both Markdown references (e.g., `(reference-name)=`) and reStructuredText labels (e.g., `.. _reference-name:`) across both .md and .rst files, as Sphinx supports cross-referencing between different markup formats.

Applied to files:

  • docs/admin/scale/expand.md
📚 Learning: 2025-10-24T02:57:47.698Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 438
File: docs/feature/query/index.md:56-56
Timestamp: 2025-10-24T02:57:47.698Z
Learning: In the cratedb-guide documentation project, the Jinja2 template pattern `{{ '{}(#anchor-name)'.format(variable) }}` is used to render badges, not to create cross-references. This pattern should not be converted to reStructuredText `{ref}` syntax. The variable (e.g., `tutorial`) is typically defined in included files like `_include/links.md` and dynamically generates badge markup.

Applied to files:

  • docs/admin/scale/expand.md
📚 Learning: 2025-08-23T20:37:34.395Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 235
File: docs/start/query/performance.md:1-3
Timestamp: 2025-08-23T20:37:34.395Z
Learning: When analyzing cross-references in mixed reStructuredText/Markdown Sphinx documentation projects, check for both RST-style labels (`.. _label:`) and Markdown-style labels (`(label)=`) as they can be cross-referenced between different file formats.

Applied to files:

  • docs/admin/scale/expand.md
📚 Learning: 2025-08-10T17:09:32.616Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 241
File: docs/integrate/azure-functions/index.md:31-36
Timestamp: 2025-08-10T17:09:32.616Z
Learning: In the CrateDB Guide documentation, RST files (`.rst`) use reStructuredText anchor syntax `.. _anchor-name:` while Markdown files (`.md`) use MyST syntax `(anchor-name)=`. Cross-references between MyST Markdown and reStructuredText files work correctly - a MyST `:link:` directive can reference an RST anchor and vice versa.

Applied to files:

  • docs/admin/scale/expand.md
📚 Learning: 2025-08-09T11:03:33.178Z
Learnt from: amotl
Repo: crate/cratedb-guide PR: 236
File: docs/ingest/etl/index.md:22-23
Timestamp: 2025-08-09T11:03:33.178Z
Learning: In the CrateDB Guide documentation, MyST Markdown files can use `{ref}` directives to reference labels defined in reStructuredText files using the RST syntax `.. _label:`. This cross-format referencing between MyST and RST is supported by Sphinx.

Applied to files:

  • docs/admin/scale/expand.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.

@amotl amotl force-pushed the fix-broken-links-1102 branch from 2e19fa5 to e48b86e Compare November 2, 2025 00:08
@amotl amotl added the cross linking Linking to different locations of the documentation. label Nov 2, 2025
@amotl amotl merged commit 1dda853 into main Nov 2, 2025
3 checks passed
@amotl amotl deleted the fix-broken-links-1102 branch November 2, 2025 00:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cross linking Linking to different locations of the documentation. maintenance C'est la vie.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants