Skip to content

Conversation

@vsurresh
Copy link
Contributor

@vsurresh vsurresh commented Jul 20, 2025

The 'generators' link is missing the extension, so clicking the link from the doc results in a broken page. Quick fix.

Summary by CodeRabbit

  • Documentation
    • Updated a hyperlink in the Resource Manager guide to point to the generators topic on the docs site, improving navigation and link accuracy.

@coderabbitai
Copy link

coderabbitai bot commented Jul 20, 2025

Walkthrough

A documentation file was updated to change a hyperlink target in docs/docs/python-sdk/guides/resource-manager.mdx from a repository-backed path to an external site URL (https://docs.infrahub.app/topics/generator). No other textual or functional changes were made.

Changes

File(s) Change Summary
docs/docs/python-sdk/guides/resource-manager.mdx Updated a hyperlink target from a repository path to https://docs.infrahub.app/topics/generator.

Sequence Diagram(s)

No sequence diagram generated as the change is limited to documentation hyperlink updates.

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 title succinctly conveys the primary change by indicating that a broken link was fixed, which directly reflects the update made to correct the documentation hyperlink.
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 doc_broken_link

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between af0aa36 and ef1da98.

📒 Files selected for processing (1)
  • docs/docs/python-sdk/guides/resource-manager.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/docs/python-sdk/guides/resource-manager.mdx

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.

@github-actions github-actions bot added the type/documentation Improvements or additions to documentation label Jul 20, 2025
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Jul 20, 2025

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: ef1da98
Status: ✅  Deploy successful!
Preview URL: https://67cd41a4.infrahub-sdk-python.pages.dev
Branch Preview URL: https://doc-broken-link.infrahub-sdk-python.pages.dev

View logs

Copy link

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/docs/python-sdk/guides/resource-manager.mdx (1)

183-183: Prefer a relative link over a hard-coded GitHub URL

Hard-coding the full GitHub path ties the docs to one repo location and breaks in offline or versioned site builds. A relative link keeps everything within the Docusaurus routing and is easier to maintain.

-[generators](https://github.com/opsmill/infrahub-docs/blob/main/docs/docs/topics/generator.mdx)
+[generators](/docs/topics/generator)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d89883 and af0aa36.

📒 Files selected for processing (1)
  • docs/docs/python-sdk/guides/resource-manager.mdx (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). (1)
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
docs/docs/python-sdk/guides/resource-manager.mdx (1)

183-183: Fixed broken link – looks good

Adding the .mdx extension removes the 404 and restores navigation. Nice catch!

Copy link
Contributor

@dgarros dgarros left a comment

Choose a reason for hiding this comment

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

Thanks @vsurresh
I think the link should be https://docs.infrahub.app/topics/generator instead
Not sure why we are pointing at the Github repository but this looks wrong to me.

@dgarros dgarros merged commit d8f58b5 into stable Oct 11, 2025
14 checks passed
@dgarros dgarros deleted the doc_broken_link branch October 11, 2025 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants