Skip to content

docs: fix internal links, ecosystem route, and MDX badges#1437

Open
JuanmaBM wants to merge 2 commits intoambient-code:mainfrom
JuanmaBM:docs/md-badges-and-ecosystem-links
Open

docs: fix internal links, ecosystem route, and MDX badges#1437
JuanmaBM wants to merge 2 commits intoambient-code:mainfrom
JuanmaBM:docs/md-badges-and-ecosystem-links

Conversation

@JuanmaBM
Copy link
Copy Markdown

@JuanmaBM JuanmaBM commented Apr 23, 2026

Summary

Improves the Starlight documentation site by correcting relative URLs that resolved incorrectly for nested pages, fixing an ecosystem page link, and ensuring Starlight Badge components render by using MDX where needed.

Changes

Workflow and ecosystem links

  • Updated links from concepts/workflows.md to the top-level Workflows section (/workflows/...) to use ../../workflows/... instead of ../workflows/.... Browsers resolve relative URLs from the current page path (/concepts/workflows/), so a single ../ targeted the wrong segment and produced paths like /concepts/workflows/custom/ instead of /workflows/custom/.

  • Fixed the “Workflows” link on the Amber ecosystem page: from ecosystem/amber/, one ../ is not enough to reach the docs root; changed to ../../concepts/workflows/ and normalized the trailing slash.

Starlight Badge components (AgentReady, GitHub Action, MCP Server)

  • Restored the Badge + import pattern for status labels (Stable / Beta). These only work when the file is processed as MDX; in plain .md the import can appear as literal text.

  • Renamed ecosystem/agentready.md → ecosystem/agentready.mdx, and extensions/github-action.md / extensions/mcp-server.md → .mdx. Public URLs (slugs) are unchanged.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Fixed internal navigation links in workflows documentation to properly reference related pages.
    • Corrected ecosystem documentation links to workflows resources.

Signed-off-by: JuanmaBM <juanmabareamartinez@gmail.com>
Signed-off-by: JuanmaBM <juanmabareamartinez@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 23, 2026

Deploy Preview for cheerful-kitten-f556a0 ready!

Name Link
🔨 Latest commit 9526e92
🔍 Latest deploy log https://app.netlify.com/projects/cheerful-kitten-f556a0/deploys/69e9d691431e910008018ddb
😎 Deploy Preview https://deploy-preview-1437--cheerful-kitten-f556a0.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 889b9533-e034-40d3-85e5-944b087d9786

📥 Commits

Reviewing files that changed from the base of the PR and between 278f6bb and 9526e92.

📒 Files selected for processing (5)
  • docs/src/content/docs/concepts/workflows.md
  • docs/src/content/docs/ecosystem/agentready.mdx
  • docs/src/content/docs/ecosystem/amber.md
  • docs/src/content/docs/extensions/github-action.mdx
  • docs/src/content/docs/extensions/mcp-server.mdx

📝 Walkthrough

Walkthrough

Documentation updates correcting relative path references in internal navigation links across two files. Changes adjust directory traversal levels to point to the correct documentation pages.

Changes

Cohort / File(s) Summary
Documentation Navigation Links
docs/src/content/docs/concepts/workflows.md, docs/src/content/docs/ecosystem/amber.md
Updated relative path references in internal navigation links. Adjusted directory traversal from ../workflows/... to ../../workflows/... and added trailing slashes to ensure correct routing to workflow documentation pages.
🚥 Pre-merge checks | ✅ 8
✅ Passed checks (8 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title follows Conventional Commits format (docs: description) and accurately summarizes the main changes: internal link fixes, ecosystem route correction, and MDX badge restoration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Performance And Algorithmic Complexity ✅ Passed PR contains only documentation changes—markdown link updates and .md to .mdx conversions with Badge imports. No algorithmic code, performance implications, or computational impact.
Security And Secret Handling ✅ Passed PR modifies only documentation files with relative link updates; no sensitive data, credentials, API keys, or security vulnerabilities detected.
Kubernetes Resource Safety ✅ Passed Kubernetes Resource Safety check is not applicable; PR contains only documentation changes (markdown/MDX files) with no modifications to Kubernetes manifests, deployments, CRDs, RBAC policies, or resource configurations.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified code

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.

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.

1 participant