-
Notifications
You must be signed in to change notification settings - Fork 6
fix(docs): broken links to .infrahub.yml #522
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Fatih Acar <[email protected]>
WalkthroughUpdated a documentation hyperlink in docs/docs/python-sdk/topics/object_file.mdx within the “Load Object files” section. The external link was changed from https://docs.infrahub.app/topics/infrahub-yml#objects to https://docs.infrahub.app/topics/infrahub-yml. No code files were modified, and there were no changes to exported or public declarations. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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 (3)
docs/docs/python-sdk/topics/object_file.mdx (3)
41-41: Confirm anchor removal and prefer site‑relative link for portabilityIf the “Objects” section anchor still exists, consider linking directly to it; otherwise, anchorless is fine. Also, use a site‑relative URL to work across preview deployments.
- > Object files can also be loaded into Infrahub when using external Git repositories. To see how to do this, please refer to the [.infrahub.yml](https://docs.infrahub.app/topics/infrahub-yml) documentation. + > Object files can also be loaded into Infrahub when using external Git repositories. To see how to do this, please refer to the [.infrahub.yml](/topics/infrahub-yml) documentation. + + <!-- If the anchor exists, prefer this instead --> + <!-- > Object files can also be loaded into Infrahub when using external Git repositories. To see how to do this, please refer to the [.infrahub.yml](/topics/infrahub-yml#objects) documentation. -->
5-5: Unify capitalization between title and H1Title uses “Object Files” (title case) while H1 uses “Object files”. Align them for consistency.
-# Manage data with Object files +# Manage data with Object Files
121-121: Grammar: “syntaxes” (plural) instead of “syntax”Minor wording tweak.
-Two different syntax are supported: +Two different syntaxes are supported:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/docs/python-sdk/topics/object_file.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
docs/**/*.{md,mdx}: Follow the Diataxis framework and classify docs as Tutorials, How-to guides, Explanation, or Reference
Structure How-to guides with required frontmatter and sections: introduction, prerequisites, step-by-step steps, validation, related resources
Structure Topics (Explanation) docs with introduction, concepts & definitions, background & context, architecture & design, connections, further reading
Use a professional, concise, informative tone with consistent structure across documents
Use proper language tags on all code blocks
Include both async and sync examples where applicable using the Tabs component
Add validation steps to guides to confirm success and expected outputs
Use callouts for warnings, tips, and important notes
Define new terms on first use and use domain-relevant terminology consistent with Infrahub’s model/UI
Conform to markdown style rules in .markdownlint.yaml and Vale styles in .vale/styles/
Files:
docs/docs/python-sdk/topics/object_file.mdx
Summary by CodeRabbit