Skip to content

Comments

Group Intro under OpenML Server nav#242

Open
kronzter wants to merge 1 commit intoopenml:mainfrom
kronzter:patch-1
Open

Group Intro under OpenML Server nav#242
kronzter wants to merge 1 commit intoopenml:mainfrom
kronzter:patch-1

Conversation

@kronzter
Copy link

@kronzter kronzter commented Feb 18, 2026

Grouped it together.
Fixes #208

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 18, 2026

Walkthrough

The mkdocs.yml configuration file was updated to reorganize the documentation navigation structure. The Intro and Getting Started pages were grouped under a new "OpenML Server" section, and the migration.md changelog entry was repositioned within this group rather than appearing at the top level. Additionally, several markdown extensions were introduced including admonition, pymdownx.details, pymdownx.superfences with alternate styling, pymdownx.tabbed, pymdownx.emoji, and tables support. The existing plugins configuration remained unchanged.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: grouping the Intro documentation under a new 'OpenML Server' navigation section in mkdocs.yml.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description references issue #208 and describes grouping items together, which aligns with the mkdocs.yml changes that reorganize navigation by moving Intro and Getting Started under an 'OpenML Server' group.

✏️ 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

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 reviewed your changes and they look great!


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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
mkdocs.yml (1)

36-36: ⚠️ Potential issue | 🟡 Minor

pymdownx.emoji is missing required emoji_index and emoji_generator options.

Without these, the extension falls back to the legacy EmojiOne 2.2.7 index. Material icon shortcodes (:material-*:, :fontawesome-*:, :octicons-*:) will silently not resolve, and emojis won't be rendered as inline SVGs through the Material theme's pipeline.

The Material for MkDocs documentation shows the correct configuration as emoji_index: !!python/name:material.extensions.emoji.twemoji and emoji_generator: !!python/name:material.extensions.emoji.to_svg.

🛠️ Proposed fix
-  - pymdownx.emoji
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@mkdocs.yml` at line 36, Add the required options for the pymdownx.emoji
extension in mkdocs.yml so it uses the Material theme emoji backend: under the
extensions list entry for "pymdownx.emoji" add the keys emoji_index and
emoji_generator with values !!python/name:material.extensions.emoji.twemoji and
!!python/name:material.extensions.emoji.to_svg respectively; this ensures
material shortcodes (e.g. :material-*: , :fontawesome-*: , :octicons-*: )
resolve and emojis are rendered as inline SVGs via the Material pipeline.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@mkdocs.yml`:
- Line 36: Add the required options for the pymdownx.emoji extension in
mkdocs.yml so it uses the Material theme emoji backend: under the extensions
list entry for "pymdownx.emoji" add the keys emoji_index and emoji_generator
with values !!python/name:material.extensions.emoji.twemoji and
!!python/name:material.extensions.emoji.to_svg respectively; this ensures
material shortcodes (e.g. :material-*: , :fontawesome-*: , :octicons-*: )
resolve and emojis are rendered as inline SVGs via the Material pipeline.

@PGijsbers
Copy link
Contributor

Hi! Thanks for taking the time to contribute to our repository! Unfortunately, this is not quite what I meant. This configuration leads to two "OpenML Server" items on the sidebar:
afbeelding

What I intended is for there to be just one item. If you go to the link for the issue (the materials docs), you can see the intended layout:

  • There is a "Setup" item on the side bar (for us, "OpenML Server")
  • Clicking it gets you to an overview page (for us, index.md)
  • The index.md page is not otherwise included in the menu anymore.

The Getting Started and Migration tabs can remain separate items in the sidebar.

Is that clear? Please let me know if you have any questions.

Copy link
Contributor

@PGijsbers PGijsbers left a comment

Choose a reason for hiding this comment

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

Thanks for taking an interest! Please have a look at the comment I left separately on the intended layout.

@kronzter
Copy link
Author

kronzter commented Feb 20, 2026

Thanks for taking an interest! Please have a look at the comment I left separately on the intended layout.

20260220-1747-00.2019047.mp4

Do you mean something like this?
p.s: also added search beccause the material reference had it.

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