docs(readme): fix broken link to AI compatible docs

[adrianschmidt]

Summary by CodeRabbit

• Documentation
  • Updated documentation reference link to provide direct access to the documentation index, improving user navigation to comprehensive resources.

Review:

• Commits are atomic
• Commits have the correct type for the changes made
• Commits with breaking changes are marked as such

Browsers tested:

(Check any that applies, it's ok to leave boxes unchecked if testing something didn't seem relevant.)

Windows:

• Chrome
• Edge
• Firefox

Linux:

• Chrome
• Firefox

macOS:

• Chrome
• Firefox
• Safari

Mobile:

• Chrome on Android
• iOS

[coderabbitai]

📝 Walkthrough

Walkthrough

Updated the documentation link in README.md from markdown-docs/ to markdown-docs/INDEX.md, directing the "Latest version" reference to a specific index file rather than the directory.

Changes

Cohort / File(s)	Change Summary
Documentation link update README.md	Updated the AI-friendly documentation reference link to point to markdown-docs/INDEX.md instead of the markdown-docs/ directory

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• PR Add Context7 compatible docs (AI-readable docs) #3703: Adds Context7-compatible docs including an INDEX.md file that this PR links to
• PR Make our docs more attractive for developers and consumers #3607: Also modifies README.md and may have conflicting changes to the same file

Suggested labels

docs

Suggested reviewers

• civing

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "docs(readme): fix broken link to AI compatible docs" is clear, concise, and directly related to the main change. The title accurately summarizes the changeset, which involves updating a link in README.md from markdown-docs/ to markdown-docs/INDEX.md to fix a broken reference to AI-compatible documentation. The title uses proper conventional commit formatting and provides enough specificity that a teammate scanning the repository history would understand the primary purpose of this change without ambiguity.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-broken-link-in-readme

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2aa60ec and 2e93faa.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Docs / Publish Docs
• GitHub Check: Test
• GitHub Check: Build

🔇 Additional comments (1)

README.md (1)

186-186: Approve the documentation link fix.

The update to point to a specific INDEX.md file instead of the directory is the correct approach for documentation routing. The change is syntactically correct and aligns with standard practices.

Please verify that the URL resolves correctly by checking:

1. The file markdown-docs/INDEX.md exists in the published documentation
2. The full URL path works: https://lundalogik.github.io/lime-elements/versions/latest/markdown-docs/INDEX.md

You can test this locally or review the deployment configuration to ensure the documentation generation and publishing process correctly places the INDEX.md file at this location.

---

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

[lime-opensource]

🎉 This PR is included in version 38.29.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀