Skip to content

docs: correctly roll intro into single OpenML Server nav item#254

Open
Gokul-social wants to merge 2 commits intoopenml:mainfrom
Gokul-social:docs/fix-openml-server-nav
Open

docs: correctly roll intro into single OpenML Server nav item#254
Gokul-social wants to merge 2 commits intoopenml:mainfrom
Gokul-social:docs/fix-openml-server-nav

Conversation

@Gokul-social
Copy link

Fixes #208

This PR updates the MkDocs navigation structure to match the intended layout discussed in the issue and PR #242.

Changes:

  • Adds a single top-level "OpenML Server" nav item pointing directly to index.md
  • Removes the separate "Intro" entry to avoid duplicate sidebar items
  • Keeps "Getting Started" and "Changes" as separate sidebar items

This ensures only one "OpenML Server" item appears in the sidebar and matches the intended MkDocs Material layout.

Copilot AI review requested due to automatic review settings February 24, 2026 09:20
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5b702aa and eccee64.

📒 Files selected for processing (1)
  • mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • mkdocs.yml

Walkthrough

The mkdocs.yml navigation was updated: the top-level nav label for index.md was renamed from "Intro" to "OpenML Server". Minor formatting changes were added (extra newlines before the Contributing block and before the Changes: migration.md entry). The Changes: migration.md item remains present in the navigation.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: reorganizing the navigation structure to consolidate the intro page into a single top-level OpenML Server nav item.
Description check ✅ Passed The description is related to the changeset and clearly explains the navigation structure updates, referencing the linked issue and intended layout.
Linked Issues check ✅ Passed The PR successfully implements the objective from issue #208 by consolidating the intro into a single top-level OpenML Server navigation item, matching the MkDocs Material pattern.
Out of Scope Changes check ✅ Passed All changes are scoped to the mkdocs.yml file and directly address the navigation structure reorganization objective without introducing unrelated modifications.
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

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.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • The nav reordering moves Changes above the Contributing section (previously it was below); double-check that this new position matches the intended sidebar hierarchy and UX, since the issue description only mentions deduplication, not reordering.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The nav reordering moves `Changes` above the `Contributing` section (previously it was below); double-check that this new position matches the intended sidebar hierarchy and UX, since the issue description only mentions deduplication, not reordering.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR resolves issue #208 by restructuring the MkDocs navigation to consolidate the intro page under a single "OpenML Server" top-level navigation item, matching the MkDocs Material design pattern referenced in the issue. The change improves the documentation structure by eliminating duplicate sidebar entries and creating a clearer hierarchy.

Changes:

  • Renamed the "Intro" navigation item to "OpenML Server" to serve as the main entry point
  • Relocated the "Changes" item to appear before the "Contributing" section for better logical grouping

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

Roll "intro" page into top nav item

2 participants