Skip to content

docs: improve README structure and website navigation#130

Merged
feloy merged 1 commit intokortex-hub:mainfrom
feloy:website2
Mar 27, 2026
Merged

docs: improve README structure and website navigation#130
feloy merged 1 commit intokortex-hub:mainfrom
feloy:website2

Conversation

@feloy
Copy link
Copy Markdown
Contributor

@feloy feloy commented Mar 27, 2026

Restructured the Podman Runtime section by promoting it to a top-level section and removing the empty Runtimes parent section. Added documentation badge linking to the project website. Also increased website TOC depth to 4 levels for better navigation. Removes the Edit button.

Fixes #129

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1180cf99-eb51-4f2d-8e18-b99df0dee223

📥 Commits

Reviewing files that changed from the base of the PR and between 3ac6399 and ffa6dff.

📒 Files selected for processing (2)
  • README.md
  • website/mkdocs.yml
✅ Files skipped from review due to trivial changes (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • website/mkdocs.yml

📝 Walkthrough

Walkthrough

Promoted the Podman Runtime section to a top-level README heading, adjusted several subsection heading levels and inline heading styles, added a Documentation badge, and increased MkDocs toc depth from 3 to 4 while removing the repository edit link setting.

Changes

Cohort / File(s) Summary
README Documentation Structure
README.md
Promoted "Podman Runtime" to top-level, decremented multiple Podman subsections (e.g., Container Image, Installed Packages, User and Permissions, AI Agent, Working Directory) by one heading level, replaced H2/H3 headings with inline bold headings for some sections, added Documentation badge, removed an extra blank line near Codecov badge.
MkDocs Configuration
website/mkdocs.yml
Removed edit_uri / theme content.action.edit setting and increased Markdown TOC depth (markdown_extensions.toc.toc_depth) from 3 to 4 to expose deeper heading levels in site navigation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • Website #125: Edits to README heading levels and MkDocs toc/edit_uri changes that interact with the README-splitting hook and site configuration.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR addresses most objectives from issue #129: promotes Podman Runtime to top-level [#129], adds documentation badge [#129], and increases TOC depth to 4 levels [#129]. However, it does not move Introduction content to home page as required [#129]. Add changes to move the Introduction section content to the home page to fully comply with issue #129 requirements.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: improving README structure and website navigation through reorganization and configuration updates.
Description check ✅ Passed The description is directly related to the changeset, explaining the restructuring of README sections, adding documentation badge, and updating website TOC depth.
Out of Scope Changes check ✅ Passed The PR includes changes to remove the edit URI and disable edit feature in website configuration, which aligns with the PR's website navigation improvements but was not explicitly mentioned in issue #129.
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.


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
Copy Markdown

@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.

🧹 Nitpick comments (1)
README.md (1)

8-8: Keep these as headings instead of bold-only labels.

Line 8 and Line 14 use bold text where section headings are expected. This reduces semantic structure and prevents these sections from appearing in heading-based navigation/TOC.

Suggested change
-**Supported Agents**
+## Supported Agents
...
-**Key Features**
+## Key Features

Also applies to: 14-14

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 8, Convert the bold-only labels to proper Markdown
headings: replace the bold text "**Supported Agents**" (and the other bold label
at line 14) with a heading level appropriate for the document (e.g., "##
Supported Agents") so these sections become real headings usable by TOC and
heading-based navigation; keep the same text content, only change the Markdown
syntax to a heading marker and ensure consistent heading levels across the
README.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 8: Convert the bold-only labels to proper Markdown headings: replace the
bold text "**Supported Agents**" (and the other bold label at line 14) with a
heading level appropriate for the document (e.g., "## Supported Agents") so
these sections become real headings usable by TOC and heading-based navigation;
keep the same text content, only change the Markdown syntax to a heading marker
and ensure consistent heading levels across the README.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5c7560af-a5fd-4bde-9a49-26ba29225802

📥 Commits

Reviewing files that changed from the base of the PR and between 2db3f4b and 3ac6399.

📒 Files selected for processing (2)
  • README.md
  • website/mkdocs.yml

Restructured the Podman Runtime section by promoting it to a
top-level section and removing the empty Runtimes parent section.
Added documentation badge linking to the project website. Also
increased website TOC depth to 4 levels for better navigation.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Philippe Martin <phmartin@redhat.com>
@feloy feloy merged commit da91bb2 into kortex-hub:main Mar 27, 2026
6 checks passed
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.

Adapt README sections for website

3 participants