Skip to content

Comments

TOC: Primary navigation improvements 202602a#543

Merged
bmunkholm merged 3 commits intomainfrom
toc-202602a
Feb 9, 2026
Merged

TOC: Primary navigation improvements 202602a#543
bmunkholm merged 3 commits intomainfrom
toc-202602a

Conversation

@amotl
Copy link
Member

@amotl amotl commented Feb 7, 2026

About

A few inches towards a recent proposal by @bmunkholm and @kneth to improve the primary navigation.

Details

  • Effectively dissolve the "topics" section.
    • Relocate concerns about "software testing" into the "connect" section.
    • What's left after removing the link to the "machine learning" section are just category index pages referencing items within the "integrate" section, so just relocate them inside.
  • Shuffle a few items within the primary navigation as suggested.

Preview

image

-- https://cratedb-guide--543.org.readthedocs.build/
-- https://cratedb-guide--543.org.readthedocs.build/connect/testing/

References

/cc @surister, @matriv, @seut

@coderabbitai
Copy link

coderabbitai bot commented Feb 7, 2026

Walkthrough

This pull request restructures the documentation navigation and expands language driver coverage across three key sections: adding 20+ language-specific driver cards and Software Testing to the connect guide, reorganizing handbook navigation entries, and simplifying the integrate category overview while removing redundant Software Testing content.

Changes

Cohort / File(s) Summary
Connect Guide Expansion
docs/connect/index.md
Added Software Testing integration instruction card and expanded drivers/apps grid with 20+ new language-specific driver cards (ODBC, C#, Elixir, Erlang, F#, Go, Groovy, Java, JavaScript, Julia, Kotlin, Perl, PHP, Python, R, Ruby, Rust, Scala, Visual Basic, Zig). Updated toctree to include testing reference.
Handbook Navigation Restructuring
docs/handbook/index.md
Reorganized toctree entries: added Solutions, Ingestion, Integrate, and Feature references with reordered sequence; removed Topic entry from navigation hierarchy.
Integrate Section Consolidation
docs/integrate/category/overview.md, docs/integrate/index.md
Removed Software Testing section from category overview and trimmed Machine Learning details to single-line summary. Updated glob pattern from **/index to */index and added new toctree section linking to category/overview with introductory text.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested labels

reorganize, refactoring, cross linking

Suggested reviewers

  • kneth
  • bmunkholm
  • surister

Poem

🐰 A rabbit hops through docs so grand,
Twenty drivers now expand the land,
Handbook reorganized with care,
Categories pruned and placed with flair,
Navigation blooms, connections shine! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly references primary navigation improvements and includes a version/date identifier, directly matching the changeset which restructures navigation across multiple documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description clearly relates to the changeset, explaining navigation structure improvements including moving Software Testing to Connect, dissolving Topics section, and relocating items within Integrations.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch toc-202602a

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.

@amotl amotl changed the title TOC improvements 202602a TOC: Primary navigation improvements 202602a Feb 7, 2026
@amotl amotl requested review from bmunkholm and kneth February 7, 2026 23:27
@amotl amotl marked this pull request as ready for review February 7, 2026 23:28
@amotl amotl added reorganize Moving content around, inside and between other systems. sanding-1200 Fine sanding. labels Feb 8, 2026
:glob:

**/index
*/index
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps move the "By category" up to the top, perhaps even enumerate them directly?

And then the long index afterwards?

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@bmunkholm bmunkholm left a comment

Choose a reason for hiding this comment

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

Great step, and in itself a good valid improvement.

More needs done with the integrations as the TOC index is simply too long. But let's leave that for another PR and this focusing on dissolving the "Topic" 👍.

Optional: remove Rockset migration entirely? Likely no one is left to migrate.

@bmunkholm bmunkholm merged commit 3743f50 into main Feb 9, 2026
3 checks passed
@bmunkholm bmunkholm deleted the toc-202602a branch February 9, 2026 16:00
@bmunkholm
Copy link
Contributor

I've merged so I can build on top of this. We can always fix some of the suggestions I had later.

@amotl
Copy link
Member Author

amotl commented Feb 9, 2026

Perhaps move the "By category" up to the top?

Optional: remove Rockset migration entirely? Likely no one is left to migrate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

reorganize Moving content around, inside and between other systems. sanding-1200 Fine sanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants