fix(diataxis): use README.md as navigation root instead of index.md

[yordis]

Summary

• Replace index.md with README.md in the directory structure example
• Add explicit instruction in Step 5: "Always use README.md as the root navigation file — never index.md."

Test plan

• Verify diataxis-organize-docs skill no longer generates index.md as the nav hub

[cursor]

PR Summary

Low Risk
Documentation-only changes with no runtime or data-handling impact; risk is limited to potential mismatch with existing docs conventions.

Overview
Updates contributor guidance to require scoped Conventional Commits (using the release-please component) when changing a plugin, with updated examples.

Adjusts the diataxis-organize-docs skill documentation to standardize the docs navigation hub on README.md instead of index.md, including an explicit instruction to never use index.md as the root nav file.

^{Written by Cursor Bugbot for commit 711bf7e. This will update automatically on new commits. Configure here.}

[coderabbitai]

Warning

Rate limit exceeded

@yordis has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 23 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: dd124881-8642-4dc8-99ca-60b48fbe87db

📥 Commits

Reviewing files that changed from the base of the PR and between 8ac246e and 711bf7e.

📒 Files selected for processing (2)

• CONTRIBUTING.md
• plugins/trogonstack-diataxis/skills/diataxis-organize-docs/SKILL.md

Walkthrough

Documentation update clarifying that README.md should serve as the root navigation file for documentation projects instead of index.md, with an explicit rule note and updated example in the diataxis organization skill documentation.

Changes

Cohort / File(s)	Summary
Documentation Configuration plugins/trogonstack-diataxis/skills/diataxis-organize-docs/SKILL.md	Updated navigation hub reference from index.md to README.md; added explicit rule stating README.md is the required root navigation file and clarified that index.md should never be used for this purpose.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README blooms where index once stood,
Clearer paths through documentation wood,
One simple truth, now plain to see—
README's root, as it should be! 📚✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: replacing index.md with README.md as the navigation root in the diataxis skill documentation.
Description check	✅ Passed	The description is directly related to the changeset, clearly explaining the replacement of index.md with README.md and the explicit instruction added.
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 fix-dia

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

plugins/trogonstack-diataxis/skills/diataxis-organize-docs/SKILL.md (1)

168-168: Consider dropping “Index” from the section wording too.

The new rule is clear, but the Step 5 title still says “Create Navigation Index,” which can nudge readers back toward index.md. Renaming that section to something like “Create Root Navigation README” would make the guidance fully self-consistent.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@plugins/trogonstack-diataxis/skills/diataxis-organize-docs/SKILL.md` at line
168, Update the Step 5 section title in SKILL.md that currently reads "Create
Navigation Index" to a title that enforces using README.md as the root nav
(e.g., "Create Root Navigation README" or "Create Root README Navigation") and
also update any internal references or mentions of "Index" in that step so the
wording consistently discourages use of index.md across the whole "Create
Navigation Index" section.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@plugins/trogonstack-diataxis/skills/diataxis-organize-docs/SKILL.md`:
- Line 168: Update the Step 5 section title in SKILL.md that currently reads
"Create Navigation Index" to a title that enforces using README.md as the root
nav (e.g., "Create Root Navigation README" or "Create Root README Navigation")
and also update any internal references or mentions of "Index" in that step so
the wording consistently discourages use of index.md across the whole "Create
Navigation Index" section.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b1d4690c-f5d6-4e19-b127-d378a6934c58

📥 Commits

Reviewing files that changed from the base of the PR and between 3eb32c6 and 8ac246e.

📒 Files selected for processing (1)

• plugins/trogonstack-diataxis/skills/diataxis-organize-docs/SKILL.md