Skip to content

Remove redundant index pages#538

Merged
bmunkholm merged 4 commits intomainfrom
bm/remove-redundant-index-pages
Jan 27, 2026
Merged

Remove redundant index pages#538
bmunkholm merged 4 commits intomainfrom
bm/remove-redundant-index-pages

Conversation

@bmunkholm
Copy link
Contributor

@bmunkholm bmunkholm commented Jan 27, 2026

About

This removes 3 "index" pages without original content from the guide to simplify the TOC of the Handbook.

Rationale

No original content is removed. As all pages are only indexes into other pages, and the content they link to are nicely located next to the relevant topics anyway, it's not clear they have a net positive result, but are more clutter in the Handbook index at the moment.

Tutorials

This page has been superseded by the Getting Started page that now has the same links to the 4 tutorials.

Explanations

This page links to just 2 other pages in the "All Features" section. This seems redundant without adding much value?

How-to guides

This only links to tutorials/how-to guides for Integrations. So if anywhere, it should be in the Integrations section.
But as the "index" is the year of publication which isn't really a relevant index into a long list anyway, I suggest we remove it entirely.

Preview

https://cratedb-guide--538.org.readthedocs.build/

@coderabbitai
Copy link

coderabbitai bot commented Jan 27, 2026

Walkthrough

This PR deletes three documentation index pages (docs/explain/index.md, docs/howto/index.md, docs/tutorial/index.md) and removes their references from docs/handbook/index.md. No code or public API changes are included.

Changes

Cohort / File(s) Summary
Removed documentation index pages
docs/explain/index.md, docs/howto/index.md, docs/tutorial/index.md
Deleted index pages that contained Explanations, How-to guides, and Tutorials including their rubriced link lists and feedback notes.
Updated handbook index
docs/handbook/index.md
Removed rubric heading and grid-item-cards for How-to / Tutorials / Explanations and removed toctree references to ../howto/index, ../tutorial/index, and ../explain/index.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

Suggested labels

reorganize, maintenance, cross linking, sanding-500

Suggested reviewers

  • kneth
  • surister

Poem

🐰 I hopped through folders, tidy and spry,
I cleared three pages with a blink of my eye,
The handbook now simpler, pages made small,
A neat little hop — that's the changelog call!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: removal of redundant index pages from the documentation, which directly reflects the core objective of simplifying the Handbook TOC.
Description check ✅ Passed The description provides clear rationale for removing three redundant index pages (Tutorials, Explanations, How-to guides), explaining why each is no longer needed and referencing a preview of the changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bm/remove-redundant-index-pages

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.

@bmunkholm bmunkholm force-pushed the bm/remove-redundant-index-pages branch from 631359f to d6298e5 Compare January 27, 2026 11:41
@bmunkholm bmunkholm requested review from amotl, kneth and surister January 27, 2026 11:46
Copy link
Member

@amotl amotl left a comment

Choose a reason for hiding this comment

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

Thanks! /cc @seut

@bmunkholm bmunkholm merged commit 1616845 into main Jan 27, 2026
3 checks passed
@bmunkholm bmunkholm deleted the bm/remove-redundant-index-pages branch January 27, 2026 12:45
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

Comments