Pmc-20251025-link-fixes #7476
Pmc-20251025-link-fixes #7476
Conversation
WalkthroughThis PR updates many documentation files to use explicit Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/docs/topics/activity-log.mdx (1)
55-55: Update documentation to reflect actual UI filter labels.The feature exists and works correctly, but the documentation is inaccurate. The activity log filter UI implements date range filtering as two separate filters: "Start Date" and "End Date" (line 55 in
global-events-filters.tsx), not as a single "Date range" filter as currently documented.Update the list at line 55 of
activity-log.mdxto:
- Start Date: Set a start date and time for the timeline.
- End Date: Set an end date and time for the timeline.
Or, if preferred, use a grouped format:
- Date range: Set a start and end date/time using the "Start Date" and "End Date" filters.
🧹 Nitpick comments (4)
docs/docs/guides/jinja2-transform.mdx (1)
268-268: Minor style suggestion: replace "in order to".LanguageTool suggests using "to" instead of "in order to" for more concise wording:
...please refer to the guide [adding a repository to Infrahub](../guides/repository.mdx) to sync the repository you created...docs/docs/guides/repository.mdx (1)
16-16: Consider strengthening the introductory phrasing.The phrase "If you want to know more about" is somewhat tentative. Consider a more direct phrasing like "To understand the differences between..." for a stronger, more professional tone.
docs/docs/guides/python-transform.mdx (1)
458-458: Optional: Simplify phrase for conciseness.Line 458 uses "in order to sync the repository you created and make it available within Infrahub." This could be simplified to "to sync the repository and make it available in Infrahub" for more direct phrasing.
docs/docs/guides/check.mdx (1)
13-13: Consider strengthening the introductory phrasing.Similar to other files, the phrase "If you want to know more about the differences" could be strengthened to "To understand the differences" or "For details on the differences" for a more professional, direct tone.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (90)
docs/docs/development/backend.mdx(1 hunks)docs/docs/development/docs.mdx(3 hunks)docs/docs/development/frontend/getting-set-up.mdx(1 hunks)docs/docs/development/frontend/testing-guidelines.mdx(1 hunks)docs/docs/development/git-best-practices.mdx(2 hunks)docs/docs/faq/faq.mdx(5 hunks)docs/docs/getting-started/concepts.mdx(1 hunks)docs/docs/getting-started/next-steps.mdx(2 hunks)docs/docs/getting-started/overview.mdx(4 hunks)docs/docs/getting-started/quick-start.mdx(2 hunks)docs/docs/guides/accounts-permissions.mdx(1 hunks)docs/docs/guides/change-approval-workflow.mdx(3 hunks)docs/docs/guides/check.mdx(4 hunks)docs/docs/guides/computed-attributes.mdx(5 hunks)docs/docs/guides/create-schema.mdx(2 hunks)docs/docs/guides/customize-field-ordering.mdx(3 hunks)docs/docs/guides/database-backup.mdx(1 hunks)docs/docs/guides/events-rules-actions.mdx(1 hunks)docs/docs/guides/generator.mdx(4 hunks)docs/docs/guides/import-schema.mdx(2 hunks)docs/docs/guides/installation.mdx(2 hunks)docs/docs/guides/jinja2-transform.mdx(3 hunks)docs/docs/guides/menu.mdx(1 hunks)docs/docs/guides/object-load.mdx(1 hunks)docs/docs/guides/object-storage.mdx(1 hunks)docs/docs/guides/object-template.mdx(2 hunks)docs/docs/guides/production-deployment.mdx(2 hunks)docs/docs/guides/profiles.mdx(2 hunks)docs/docs/guides/python-transform.mdx(6 hunks)docs/docs/guides/repository.mdx(5 hunks)docs/docs/guides/resource-manager.mdx(6 hunks)docs/docs/guides/sso.mdx(3 hunks)docs/docs/guides/upgrade.mdx(3 hunks)docs/docs/overview/data.mdx.old(1 hunks)docs/docs/overview/integrations.mdx.old(1 hunks)docs/docs/overview/readme.mdx.old(1 hunks)docs/docs/reference/dotinfrahub.mdx(1 hunks)docs/docs/reference/infrahub-tests.mdx(1 hunks)docs/docs/reference/menu.mdx(1 hunks)docs/docs/reference/message-bus-events.mdx(1 hunks)docs/docs/reference/permissions.mdx(1 hunks)docs/docs/reference/schema-validation.mdx(1 hunks)docs/docs/reference/sso.mdx(1 hunks)docs/docs/release-notes/infrahub/release-0_13.mdx(4 hunks)docs/docs/release-notes/infrahub/release-0_15_0.mdx(2 hunks)docs/docs/release-notes/infrahub/release-0_15_3.mdx(1 hunks)docs/docs/release-notes/infrahub/release-0_16_0.mdx(3 hunks)docs/docs/release-notes/infrahub/release-0_16_1.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_0_0.mdx(3 hunks)docs/docs/release-notes/infrahub/release-1_1_0.mdx(2 hunks)docs/docs/release-notes/infrahub/release-1_2_0.mdx(4 hunks)docs/docs/release-notes/infrahub/release-1_2_1.mdx(2 hunks)docs/docs/release-notes/infrahub/release-1_2_10.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_11.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_12.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_2.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_3.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_4.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_5.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_6.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_7.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_8.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_2_9.mdx(1 hunks)docs/docs/release-notes/infrahub/release-1_4_0.mdx(1 hunks)docs/docs/topics/activity-log.mdx(2 hunks)docs/docs/topics/authentication.mdx(1 hunks)docs/docs/topics/check.mdx(1 hunks)docs/docs/topics/computed-attributes.mdx(3 hunks)docs/docs/topics/database-backup.mdx(1 hunks)docs/docs/topics/event-actions.mdx(1 hunks)docs/docs/topics/groups.mdx(1 hunks)docs/docs/topics/hardware-requirements.mdx(1 hunks)docs/docs/topics/infrahub-yml.mdx(1 hunks)docs/docs/topics/local-demo-environment.mdx(1 hunks)docs/docs/topics/object-storage.mdx(1 hunks)docs/docs/topics/object-template.mdx(1 hunks)docs/docs/topics/permissions-roles.mdx(1 hunks)docs/docs/topics/profiles.mdx(1 hunks)docs/docs/topics/repository.mdx(2 hunks)docs/docs/topics/resources-testing-framework.mdx(3 hunks)docs/docs/topics/schema.mdx(8 hunks)docs/docs/topics/tasks.mdx(1 hunks)docs/docs/topics/transformation.mdx(3 hunks)docs/docs/tutorials/getting-started/branches.mdx(1 hunks)docs/docs/tutorials/getting-started/git-integration.mdx(3 hunks)docs/docs/tutorials/getting-started/introduction-to-infrahub.mdx(1 hunks)docs/docs/tutorials/getting-started/lineage-information.mdx(1 hunks)docs/docs/tutorials/getting-started/readme.mdx(3 hunks)docs/docs/tutorials/getting-started/rendering-configuration.mdx(1 hunks)docs/package.json(3 hunks)
🧰 Additional context used
📓 Path-based instructions (7)
docs/docs/guides/**/*.{md,mdx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Write guides in
docs/docs/guides/
Files:
docs/docs/guides/object-storage.mdxdocs/docs/guides/object-template.mdxdocs/docs/guides/menu.mdxdocs/docs/guides/create-schema.mdxdocs/docs/guides/customize-field-ordering.mdxdocs/docs/guides/events-rules-actions.mdxdocs/docs/guides/accounts-permissions.mdxdocs/docs/guides/sso.mdxdocs/docs/guides/change-approval-workflow.mdxdocs/docs/guides/database-backup.mdxdocs/docs/guides/object-load.mdxdocs/docs/guides/python-transform.mdxdocs/docs/guides/production-deployment.mdxdocs/docs/guides/installation.mdxdocs/docs/guides/jinja2-transform.mdxdocs/docs/guides/generator.mdxdocs/docs/guides/repository.mdxdocs/docs/guides/import-schema.mdxdocs/docs/guides/computed-attributes.mdxdocs/docs/guides/profiles.mdxdocs/docs/guides/upgrade.mdxdocs/docs/guides/resource-manager.mdxdocs/docs/guides/check.mdx
docs/**/*.mdx
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use Docusaurus markdown/MDX features in documentation
docs/**/*.mdx: How-to guides should begin title with "How to..." and follow the Diataxis How-to structure (intro, prerequisites, step-by-step, validation, advanced, related)
Use imperative, task-focused instructions in guides; avoid digressions
Topics should use titles like "About..." or "Understanding..." and follow the Diataxis Topics structure (concepts, background, architecture, mental models, connections, alternatives, further reading)
Define new terms on first use; prefer domain-relevant terminology; keep naming consistent with Infrahub UI/data model
Files:
docs/docs/guides/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_0.mdxdocs/docs/reference/permissions.mdxdocs/docs/release-notes/infrahub/release-0_16_1.mdxdocs/docs/guides/object-template.mdxdocs/docs/guides/menu.mdxdocs/docs/topics/computed-attributes.mdxdocs/docs/release-notes/infrahub/release-1_2_4.mdxdocs/docs/reference/infrahub-tests.mdxdocs/docs/guides/create-schema.mdxdocs/docs/release-notes/infrahub/release-1_2_12.mdxdocs/docs/release-notes/infrahub/release-1_0_0.mdxdocs/docs/release-notes/infrahub/release-0_16_0.mdxdocs/docs/getting-started/concepts.mdxdocs/docs/tutorials/getting-started/git-integration.mdxdocs/docs/topics/object-template.mdxdocs/docs/release-notes/infrahub/release-1_2_1.mdxdocs/docs/guides/customize-field-ordering.mdxdocs/docs/topics/check.mdxdocs/docs/tutorials/getting-started/introduction-to-infrahub.mdxdocs/docs/guides/events-rules-actions.mdxdocs/docs/topics/hardware-requirements.mdxdocs/docs/tutorials/getting-started/branches.mdxdocs/docs/topics/profiles.mdxdocs/docs/reference/message-bus-events.mdxdocs/docs/guides/accounts-permissions.mdxdocs/docs/guides/sso.mdxdocs/docs/release-notes/infrahub/release-0_15_3.mdxdocs/docs/guides/change-approval-workflow.mdxdocs/docs/release-notes/infrahub/release-1_2_7.mdxdocs/docs/release-notes/infrahub/release-1_2_10.mdxdocs/docs/topics/resources-testing-framework.mdxdocs/docs/release-notes/infrahub/release-1_2_5.mdxdocs/docs/topics/transformation.mdxdocs/docs/topics/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_9.mdxdocs/docs/release-notes/infrahub/release-1_2_6.mdxdocs/docs/getting-started/overview.mdxdocs/docs/guides/database-backup.mdxdocs/docs/topics/event-actions.mdxdocs/docs/release-notes/infrahub/release-1_4_0.mdxdocs/docs/getting-started/quick-start.mdxdocs/docs/development/frontend/getting-set-up.mdxdocs/docs/guides/object-load.mdxdocs/docs/release-notes/infrahub/release-0_13.mdxdocs/docs/guides/python-transform.mdxdocs/docs/topics/activity-log.mdxdocs/docs/topics/authentication.mdxdocs/docs/topics/permissions-roles.mdxdocs/docs/faq/faq.mdxdocs/docs/guides/production-deployment.mdxdocs/docs/development/backend.mdxdocs/docs/reference/schema-validation.mdxdocs/docs/release-notes/infrahub/release-1_2_3.mdxdocs/docs/guides/installation.mdxdocs/docs/guides/jinja2-transform.mdxdocs/docs/reference/sso.mdxdocs/docs/guides/generator.mdxdocs/docs/tutorials/getting-started/rendering-configuration.mdxdocs/docs/guides/repository.mdxdocs/docs/release-notes/infrahub/release-0_15_0.mdxdocs/docs/topics/local-demo-environment.mdxdocs/docs/tutorials/getting-started/readme.mdxdocs/docs/guides/import-schema.mdxdocs/docs/reference/menu.mdxdocs/docs/guides/computed-attributes.mdxdocs/docs/guides/profiles.mdxdocs/docs/topics/infrahub-yml.mdxdocs/docs/release-notes/infrahub/release-1_2_2.mdxdocs/docs/getting-started/next-steps.mdxdocs/docs/tutorials/getting-started/lineage-information.mdxdocs/docs/development/frontend/testing-guidelines.mdxdocs/docs/guides/upgrade.mdxdocs/docs/guides/resource-manager.mdxdocs/docs/topics/groups.mdxdocs/docs/topics/repository.mdxdocs/docs/guides/check.mdxdocs/docs/release-notes/infrahub/release-1_2_11.mdxdocs/docs/release-notes/infrahub/release-1_2_8.mdxdocs/docs/release-notes/infrahub/release-1_1_0.mdxdocs/docs/topics/tasks.mdxdocs/docs/topics/schema.mdxdocs/docs/development/git-best-practices.mdxdocs/docs/topics/database-backup.mdxdocs/docs/development/docs.mdxdocs/docs/reference/dotinfrahub.mdx
docs/**/*
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Develop documentation in
docs/, preview withinvoke docs.build docs.serve, and validate withinvoke docs.validate
Files:
docs/docs/guides/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_0.mdxdocs/docs/reference/permissions.mdxdocs/docs/release-notes/infrahub/release-0_16_1.mdxdocs/docs/guides/object-template.mdxdocs/docs/guides/menu.mdxdocs/docs/topics/computed-attributes.mdxdocs/docs/release-notes/infrahub/release-1_2_4.mdxdocs/docs/reference/infrahub-tests.mdxdocs/docs/guides/create-schema.mdxdocs/docs/release-notes/infrahub/release-1_2_12.mdxdocs/docs/release-notes/infrahub/release-1_0_0.mdxdocs/docs/release-notes/infrahub/release-0_16_0.mdxdocs/docs/getting-started/concepts.mdxdocs/docs/tutorials/getting-started/git-integration.mdxdocs/docs/topics/object-template.mdxdocs/docs/release-notes/infrahub/release-1_2_1.mdxdocs/docs/guides/customize-field-ordering.mdxdocs/docs/topics/check.mdxdocs/docs/tutorials/getting-started/introduction-to-infrahub.mdxdocs/docs/guides/events-rules-actions.mdxdocs/docs/topics/hardware-requirements.mdxdocs/docs/tutorials/getting-started/branches.mdxdocs/docs/topics/profiles.mdxdocs/docs/reference/message-bus-events.mdxdocs/docs/guides/accounts-permissions.mdxdocs/docs/guides/sso.mdxdocs/docs/release-notes/infrahub/release-0_15_3.mdxdocs/docs/guides/change-approval-workflow.mdxdocs/docs/release-notes/infrahub/release-1_2_7.mdxdocs/docs/release-notes/infrahub/release-1_2_10.mdxdocs/docs/topics/resources-testing-framework.mdxdocs/docs/release-notes/infrahub/release-1_2_5.mdxdocs/docs/topics/transformation.mdxdocs/docs/topics/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_9.mdxdocs/docs/release-notes/infrahub/release-1_2_6.mdxdocs/docs/getting-started/overview.mdxdocs/docs/guides/database-backup.mdxdocs/docs/topics/event-actions.mdxdocs/docs/release-notes/infrahub/release-1_4_0.mdxdocs/docs/overview/integrations.mdx.olddocs/docs/getting-started/quick-start.mdxdocs/docs/development/frontend/getting-set-up.mdxdocs/docs/guides/object-load.mdxdocs/docs/release-notes/infrahub/release-0_13.mdxdocs/docs/guides/python-transform.mdxdocs/docs/topics/activity-log.mdxdocs/docs/topics/authentication.mdxdocs/docs/topics/permissions-roles.mdxdocs/docs/faq/faq.mdxdocs/docs/guides/production-deployment.mdxdocs/docs/development/backend.mdxdocs/docs/reference/schema-validation.mdxdocs/docs/release-notes/infrahub/release-1_2_3.mdxdocs/docs/guides/installation.mdxdocs/docs/guides/jinja2-transform.mdxdocs/docs/reference/sso.mdxdocs/docs/guides/generator.mdxdocs/docs/tutorials/getting-started/rendering-configuration.mdxdocs/docs/guides/repository.mdxdocs/docs/release-notes/infrahub/release-0_15_0.mdxdocs/docs/topics/local-demo-environment.mdxdocs/docs/tutorials/getting-started/readme.mdxdocs/docs/guides/import-schema.mdxdocs/docs/overview/data.mdx.olddocs/docs/reference/menu.mdxdocs/docs/guides/computed-attributes.mdxdocs/docs/guides/profiles.mdxdocs/docs/topics/infrahub-yml.mdxdocs/docs/release-notes/infrahub/release-1_2_2.mdxdocs/docs/getting-started/next-steps.mdxdocs/docs/tutorials/getting-started/lineage-information.mdxdocs/docs/development/frontend/testing-guidelines.mdxdocs/docs/guides/upgrade.mdxdocs/docs/guides/resource-manager.mdxdocs/docs/topics/groups.mdxdocs/docs/topics/repository.mdxdocs/docs/guides/check.mdxdocs/docs/release-notes/infrahub/release-1_2_11.mdxdocs/docs/release-notes/infrahub/release-1_2_8.mdxdocs/docs/release-notes/infrahub/release-1_1_0.mdxdocs/package.jsondocs/docs/topics/tasks.mdxdocs/docs/topics/schema.mdxdocs/docs/overview/readme.mdx.olddocs/docs/development/git-best-practices.mdxdocs/docs/topics/database-backup.mdxdocs/docs/development/docs.mdxdocs/docs/reference/dotinfrahub.mdx
**/*.mdx
📄 CodeRabbit inference engine (.github/instructions/documentation.instructions.md)
**/*.mdx: Structure documentation primarily as How-to Guides and Topics (explanations) following the Diataxis framework
Use a professional, approachable tone; avoid jargon unless defined; use plain language with technical precision
Write concise, direct, active sentences
Be informative over promotional; focus on explaining how and why
Maintain consistent, predictable structure across sections and documents
For Guides: use conditional imperatives (e.g., "If you want X, do Y")
For Guides: focus on practical tasks and problems, not tools
For Guides: address the user directly with imperative verbs (e.g., "Configure...", "Create...")
For Guides: keep focus on the specific goal; avoid digressions into explanations
For Guides: title in YAML frontmatter should clearly state the problem and begin with "How to..."
For Guides: include an Introduction stating the problem/goal, context, and what the user will achieve
For Guides: include a Prerequisites/Assumptions section listing requirements and prior knowledge
For Guides: provide step-by-step instructions with numbered steps; include code snippets/screenshots/tabs/callouts as needed
For Guides: include a Validation/Verification section with checks, example outputs, and potential failure points
For Guides: include a Related Resources section linking to relevant guides/topics/reference
For Topics: title in YAML frontmatter should clearly indicate the topic; consider starting with "About..." or "Understanding..."
For Topics: include an Introduction with overview, why it matters, and questions answered
For Topics: include sections for Concepts & Definitions
For Topics: include Background & Context (history, design rationale, constraints)
For Topics: include Architecture & Design details/diagrams when applicable
For Topics: include Mental Models (analogies/comparisons)
For Topics: connect to other concepts and integration points
For Topics: include Alternative Approaches with pros/cons where relevant
For Topics: include a Further...
Files:
docs/docs/guides/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_0.mdxdocs/docs/reference/permissions.mdxdocs/docs/release-notes/infrahub/release-0_16_1.mdxdocs/docs/guides/object-template.mdxdocs/docs/guides/menu.mdxdocs/docs/topics/computed-attributes.mdxdocs/docs/release-notes/infrahub/release-1_2_4.mdxdocs/docs/reference/infrahub-tests.mdxdocs/docs/guides/create-schema.mdxdocs/docs/release-notes/infrahub/release-1_2_12.mdxdocs/docs/release-notes/infrahub/release-1_0_0.mdxdocs/docs/release-notes/infrahub/release-0_16_0.mdxdocs/docs/getting-started/concepts.mdxdocs/docs/tutorials/getting-started/git-integration.mdxdocs/docs/topics/object-template.mdxdocs/docs/release-notes/infrahub/release-1_2_1.mdxdocs/docs/guides/customize-field-ordering.mdxdocs/docs/topics/check.mdxdocs/docs/tutorials/getting-started/introduction-to-infrahub.mdxdocs/docs/guides/events-rules-actions.mdxdocs/docs/topics/hardware-requirements.mdxdocs/docs/tutorials/getting-started/branches.mdxdocs/docs/topics/profiles.mdxdocs/docs/reference/message-bus-events.mdxdocs/docs/guides/accounts-permissions.mdxdocs/docs/guides/sso.mdxdocs/docs/release-notes/infrahub/release-0_15_3.mdxdocs/docs/guides/change-approval-workflow.mdxdocs/docs/release-notes/infrahub/release-1_2_7.mdxdocs/docs/release-notes/infrahub/release-1_2_10.mdxdocs/docs/topics/resources-testing-framework.mdxdocs/docs/release-notes/infrahub/release-1_2_5.mdxdocs/docs/topics/transformation.mdxdocs/docs/topics/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_9.mdxdocs/docs/release-notes/infrahub/release-1_2_6.mdxdocs/docs/getting-started/overview.mdxdocs/docs/guides/database-backup.mdxdocs/docs/topics/event-actions.mdxdocs/docs/release-notes/infrahub/release-1_4_0.mdxdocs/docs/getting-started/quick-start.mdxdocs/docs/development/frontend/getting-set-up.mdxdocs/docs/guides/object-load.mdxdocs/docs/release-notes/infrahub/release-0_13.mdxdocs/docs/guides/python-transform.mdxdocs/docs/topics/activity-log.mdxdocs/docs/topics/authentication.mdxdocs/docs/topics/permissions-roles.mdxdocs/docs/faq/faq.mdxdocs/docs/guides/production-deployment.mdxdocs/docs/development/backend.mdxdocs/docs/reference/schema-validation.mdxdocs/docs/release-notes/infrahub/release-1_2_3.mdxdocs/docs/guides/installation.mdxdocs/docs/guides/jinja2-transform.mdxdocs/docs/reference/sso.mdxdocs/docs/guides/generator.mdxdocs/docs/tutorials/getting-started/rendering-configuration.mdxdocs/docs/guides/repository.mdxdocs/docs/release-notes/infrahub/release-0_15_0.mdxdocs/docs/topics/local-demo-environment.mdxdocs/docs/tutorials/getting-started/readme.mdxdocs/docs/guides/import-schema.mdxdocs/docs/reference/menu.mdxdocs/docs/guides/computed-attributes.mdxdocs/docs/guides/profiles.mdxdocs/docs/topics/infrahub-yml.mdxdocs/docs/release-notes/infrahub/release-1_2_2.mdxdocs/docs/getting-started/next-steps.mdxdocs/docs/tutorials/getting-started/lineage-information.mdxdocs/docs/development/frontend/testing-guidelines.mdxdocs/docs/guides/upgrade.mdxdocs/docs/guides/resource-manager.mdxdocs/docs/topics/groups.mdxdocs/docs/topics/repository.mdxdocs/docs/guides/check.mdxdocs/docs/release-notes/infrahub/release-1_2_11.mdxdocs/docs/release-notes/infrahub/release-1_2_8.mdxdocs/docs/release-notes/infrahub/release-1_1_0.mdxdocs/docs/topics/tasks.mdxdocs/docs/topics/schema.mdxdocs/docs/development/git-best-practices.mdxdocs/docs/topics/database-backup.mdxdocs/docs/development/docs.mdxdocs/docs/reference/dotinfrahub.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
Lint Markdown/MDX files with markdownlint using
.markdownlint.yaml
Files:
docs/docs/guides/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_0.mdxdocs/docs/reference/permissions.mdxdocs/docs/release-notes/infrahub/release-0_16_1.mdxdocs/docs/guides/object-template.mdxdocs/docs/guides/menu.mdxdocs/docs/topics/computed-attributes.mdxdocs/docs/release-notes/infrahub/release-1_2_4.mdxdocs/docs/reference/infrahub-tests.mdxdocs/docs/guides/create-schema.mdxdocs/docs/release-notes/infrahub/release-1_2_12.mdxdocs/docs/release-notes/infrahub/release-1_0_0.mdxdocs/docs/release-notes/infrahub/release-0_16_0.mdxdocs/docs/getting-started/concepts.mdxdocs/docs/tutorials/getting-started/git-integration.mdxdocs/docs/topics/object-template.mdxdocs/docs/release-notes/infrahub/release-1_2_1.mdxdocs/docs/guides/customize-field-ordering.mdxdocs/docs/topics/check.mdxdocs/docs/tutorials/getting-started/introduction-to-infrahub.mdxdocs/docs/guides/events-rules-actions.mdxdocs/docs/topics/hardware-requirements.mdxdocs/docs/tutorials/getting-started/branches.mdxdocs/docs/topics/profiles.mdxdocs/docs/reference/message-bus-events.mdxdocs/docs/guides/accounts-permissions.mdxdocs/docs/guides/sso.mdxdocs/docs/release-notes/infrahub/release-0_15_3.mdxdocs/docs/guides/change-approval-workflow.mdxdocs/docs/release-notes/infrahub/release-1_2_7.mdxdocs/docs/release-notes/infrahub/release-1_2_10.mdxdocs/docs/topics/resources-testing-framework.mdxdocs/docs/release-notes/infrahub/release-1_2_5.mdxdocs/docs/topics/transformation.mdxdocs/docs/topics/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_9.mdxdocs/docs/release-notes/infrahub/release-1_2_6.mdxdocs/docs/getting-started/overview.mdxdocs/docs/guides/database-backup.mdxdocs/docs/topics/event-actions.mdxdocs/docs/release-notes/infrahub/release-1_4_0.mdxdocs/docs/getting-started/quick-start.mdxdocs/docs/development/frontend/getting-set-up.mdxdocs/docs/guides/object-load.mdxdocs/docs/release-notes/infrahub/release-0_13.mdxdocs/docs/guides/python-transform.mdxdocs/docs/topics/activity-log.mdxdocs/docs/topics/authentication.mdxdocs/docs/topics/permissions-roles.mdxdocs/docs/faq/faq.mdxdocs/docs/guides/production-deployment.mdxdocs/docs/development/backend.mdxdocs/docs/reference/schema-validation.mdxdocs/docs/release-notes/infrahub/release-1_2_3.mdxdocs/docs/guides/installation.mdxdocs/docs/guides/jinja2-transform.mdxdocs/docs/reference/sso.mdxdocs/docs/guides/generator.mdxdocs/docs/tutorials/getting-started/rendering-configuration.mdxdocs/docs/guides/repository.mdxdocs/docs/release-notes/infrahub/release-0_15_0.mdxdocs/docs/topics/local-demo-environment.mdxdocs/docs/tutorials/getting-started/readme.mdxdocs/docs/guides/import-schema.mdxdocs/docs/reference/menu.mdxdocs/docs/guides/computed-attributes.mdxdocs/docs/guides/profiles.mdxdocs/docs/topics/infrahub-yml.mdxdocs/docs/release-notes/infrahub/release-1_2_2.mdxdocs/docs/getting-started/next-steps.mdxdocs/docs/tutorials/getting-started/lineage-information.mdxdocs/docs/development/frontend/testing-guidelines.mdxdocs/docs/guides/upgrade.mdxdocs/docs/guides/resource-manager.mdxdocs/docs/topics/groups.mdxdocs/docs/topics/repository.mdxdocs/docs/guides/check.mdxdocs/docs/release-notes/infrahub/release-1_2_11.mdxdocs/docs/release-notes/infrahub/release-1_2_8.mdxdocs/docs/release-notes/infrahub/release-1_1_0.mdxdocs/docs/topics/tasks.mdxdocs/docs/topics/schema.mdxdocs/docs/development/git-best-practices.mdxdocs/docs/topics/database-backup.mdxdocs/docs/development/docs.mdxdocs/docs/reference/dotinfrahub.mdx
docs/!(node_modules)/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
docs/!(node_modules)/**/*.{md,mdx}: Lint documentation prose with Vale
Ensure Vale style checks pass for documentation
Files:
docs/docs/guides/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_0.mdxdocs/docs/reference/permissions.mdxdocs/docs/release-notes/infrahub/release-0_16_1.mdxdocs/docs/guides/object-template.mdxdocs/docs/guides/menu.mdxdocs/docs/topics/computed-attributes.mdxdocs/docs/release-notes/infrahub/release-1_2_4.mdxdocs/docs/reference/infrahub-tests.mdxdocs/docs/guides/create-schema.mdxdocs/docs/release-notes/infrahub/release-1_2_12.mdxdocs/docs/release-notes/infrahub/release-1_0_0.mdxdocs/docs/release-notes/infrahub/release-0_16_0.mdxdocs/docs/getting-started/concepts.mdxdocs/docs/tutorials/getting-started/git-integration.mdxdocs/docs/topics/object-template.mdxdocs/docs/release-notes/infrahub/release-1_2_1.mdxdocs/docs/guides/customize-field-ordering.mdxdocs/docs/topics/check.mdxdocs/docs/tutorials/getting-started/introduction-to-infrahub.mdxdocs/docs/guides/events-rules-actions.mdxdocs/docs/topics/hardware-requirements.mdxdocs/docs/tutorials/getting-started/branches.mdxdocs/docs/topics/profiles.mdxdocs/docs/reference/message-bus-events.mdxdocs/docs/guides/accounts-permissions.mdxdocs/docs/guides/sso.mdxdocs/docs/release-notes/infrahub/release-0_15_3.mdxdocs/docs/guides/change-approval-workflow.mdxdocs/docs/release-notes/infrahub/release-1_2_7.mdxdocs/docs/release-notes/infrahub/release-1_2_10.mdxdocs/docs/topics/resources-testing-framework.mdxdocs/docs/release-notes/infrahub/release-1_2_5.mdxdocs/docs/topics/transformation.mdxdocs/docs/topics/object-storage.mdxdocs/docs/release-notes/infrahub/release-1_2_9.mdxdocs/docs/release-notes/infrahub/release-1_2_6.mdxdocs/docs/getting-started/overview.mdxdocs/docs/guides/database-backup.mdxdocs/docs/topics/event-actions.mdxdocs/docs/release-notes/infrahub/release-1_4_0.mdxdocs/docs/getting-started/quick-start.mdxdocs/docs/development/frontend/getting-set-up.mdxdocs/docs/guides/object-load.mdxdocs/docs/release-notes/infrahub/release-0_13.mdxdocs/docs/guides/python-transform.mdxdocs/docs/topics/activity-log.mdxdocs/docs/topics/authentication.mdxdocs/docs/topics/permissions-roles.mdxdocs/docs/faq/faq.mdxdocs/docs/guides/production-deployment.mdxdocs/docs/development/backend.mdxdocs/docs/reference/schema-validation.mdxdocs/docs/release-notes/infrahub/release-1_2_3.mdxdocs/docs/guides/installation.mdxdocs/docs/guides/jinja2-transform.mdxdocs/docs/reference/sso.mdxdocs/docs/guides/generator.mdxdocs/docs/tutorials/getting-started/rendering-configuration.mdxdocs/docs/guides/repository.mdxdocs/docs/release-notes/infrahub/release-0_15_0.mdxdocs/docs/topics/local-demo-environment.mdxdocs/docs/tutorials/getting-started/readme.mdxdocs/docs/guides/import-schema.mdxdocs/docs/reference/menu.mdxdocs/docs/guides/computed-attributes.mdxdocs/docs/guides/profiles.mdxdocs/docs/topics/infrahub-yml.mdxdocs/docs/release-notes/infrahub/release-1_2_2.mdxdocs/docs/getting-started/next-steps.mdxdocs/docs/tutorials/getting-started/lineage-information.mdxdocs/docs/development/frontend/testing-guidelines.mdxdocs/docs/guides/upgrade.mdxdocs/docs/guides/resource-manager.mdxdocs/docs/topics/groups.mdxdocs/docs/topics/repository.mdxdocs/docs/guides/check.mdxdocs/docs/release-notes/infrahub/release-1_2_11.mdxdocs/docs/release-notes/infrahub/release-1_2_8.mdxdocs/docs/release-notes/infrahub/release-1_1_0.mdxdocs/docs/topics/tasks.mdxdocs/docs/topics/schema.mdxdocs/docs/development/git-best-practices.mdxdocs/docs/topics/database-backup.mdxdocs/docs/development/docs.mdxdocs/docs/reference/dotinfrahub.mdx
docs/docs/reference/**/*.{md,mdx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Write reference documentation in
docs/docs/reference/
Files:
docs/docs/reference/permissions.mdxdocs/docs/reference/infrahub-tests.mdxdocs/docs/reference/message-bus-events.mdxdocs/docs/reference/schema-validation.mdxdocs/docs/reference/sso.mdxdocs/docs/reference/menu.mdxdocs/docs/reference/dotinfrahub.mdx
🧠 Learnings (8)
📓 Common learnings
Learnt from: CR
PR: opsmill/infrahub#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-22T08:13:56.198Z
Learning: Applies to docs/**/*.mdx : Use Docusaurus markdown/MDX features in documentation
📚 Learning: 2025-08-21T11:04:26.357Z
Learnt from: CR
PR: opsmill/infrahub#0
File: .github/instructions/documentation.instructions.md:0-0
Timestamp: 2025-08-21T11:04:26.357Z
Learning: Applies to **/*.mdx : Ensure content is accurate and reflects the latest Infrahub version
Applied to files:
docs/docs/release-notes/infrahub/release-1_2_0.mdxdocs/docs/guides/menu.mdxdocs/docs/reference/infrahub-tests.mdxdocs/docs/release-notes/infrahub/release-1_2_12.mdxdocs/docs/release-notes/infrahub/release-1_0_0.mdxdocs/docs/release-notes/infrahub/release-0_16_0.mdxdocs/docs/getting-started/concepts.mdxdocs/docs/release-notes/infrahub/release-1_2_1.mdxdocs/docs/tutorials/getting-started/introduction-to-infrahub.mdxdocs/docs/tutorials/getting-started/branches.mdxdocs/docs/release-notes/infrahub/release-0_15_3.mdxdocs/docs/release-notes/infrahub/release-1_2_7.mdxdocs/docs/release-notes/infrahub/release-1_2_10.mdxdocs/docs/topics/resources-testing-framework.mdxdocs/docs/release-notes/infrahub/release-1_2_5.mdxdocs/docs/release-notes/infrahub/release-1_2_9.mdxdocs/docs/release-notes/infrahub/release-1_2_6.mdxdocs/docs/getting-started/overview.mdxdocs/docs/release-notes/infrahub/release-1_4_0.mdxdocs/docs/release-notes/infrahub/release-0_13.mdxdocs/docs/topics/activity-log.mdxdocs/docs/faq/faq.mdxdocs/docs/reference/schema-validation.mdxdocs/docs/guides/generator.mdxdocs/docs/guides/repository.mdxdocs/docs/tutorials/getting-started/readme.mdxdocs/docs/overview/data.mdx.olddocs/docs/topics/infrahub-yml.mdxdocs/docs/getting-started/next-steps.mdxdocs/docs/guides/upgrade.mdxdocs/docs/topics/repository.mdxdocs/docs/guides/check.mdxdocs/docs/release-notes/infrahub/release-1_2_11.mdxdocs/docs/release-notes/infrahub/release-1_2_8.mdxdocs/docs/release-notes/infrahub/release-1_1_0.mdxdocs/docs/development/docs.mdxdocs/docs/reference/dotinfrahub.mdx
📚 Learning: 2025-08-21T11:04:26.357Z
Learnt from: CR
PR: opsmill/infrahub#0
File: .github/instructions/documentation.instructions.md:0-0
Timestamp: 2025-08-21T11:04:26.357Z
Learning: Applies to **/*.mdx : Assume readers know Git/CI/CD/YAML-JSON/IaC basics; do not assume prior Infrahub knowledge—introduce core concepts from first principles
Applied to files:
docs/docs/tutorials/getting-started/branches.mdxdocs/docs/guides/change-approval-workflow.mdxdocs/docs/guides/repository.mdxdocs/docs/topics/infrahub-yml.mdxdocs/docs/topics/repository.mdxdocs/docs/overview/readme.mdx.olddocs/docs/development/git-best-practices.mdx
📚 Learning: 2025-07-22T08:13:56.198Z
Learnt from: CR
PR: opsmill/infrahub#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-22T08:13:56.198Z
Learning: Documentation generated for Infrahub must reflect its novel approach, providing clarity around new concepts and demonstrating integration with familiar patterns from existing tools like Git, infrastructure-as-code, and CI/CD pipelines
Applied to files:
docs/docs/tutorials/getting-started/branches.mdxdocs/docs/guides/change-approval-workflow.mdxdocs/docs/faq/faq.mdxdocs/docs/guides/repository.mdxdocs/docs/overview/readme.mdx.old
📚 Learning: 2025-07-22T08:13:56.198Z
Learnt from: CR
PR: opsmill/infrahub#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-22T08:13:56.198Z
Learning: Infrahub offers a central hub to manage the data, templates and playbooks that powers your infrastructure by combining the version control and branch management capabilities similar to Git with the flexible data model and UI of a graph database
Applied to files:
docs/docs/getting-started/overview.mdxdocs/docs/overview/integrations.mdx.olddocs/docs/guides/object-load.mdxdocs/docs/faq/faq.mdxdocs/docs/overview/data.mdx.old
📚 Learning: 2025-08-21T11:04:26.357Z
Learnt from: CR
PR: opsmill/infrahub#0
File: .github/instructions/documentation.instructions.md:0-0
Timestamp: 2025-08-21T11:04:26.357Z
Learning: Applies to **/*.mdx : For Topics: connect to other concepts and integration points
Applied to files:
docs/docs/topics/authentication.mdx
📚 Learning: 2025-08-21T11:04:26.357Z
Learnt from: CR
PR: opsmill/infrahub#0
File: .github/instructions/documentation.instructions.md:0-0
Timestamp: 2025-08-21T11:04:26.357Z
Learning: Applies to **/*.mdx : For Guides: include a Related Resources section linking to relevant guides/topics/reference
Applied to files:
docs/docs/getting-started/next-steps.mdxdocs/docs/topics/groups.mdx
📚 Learning: 2025-08-21T11:04:26.357Z
Learnt from: CR
PR: opsmill/infrahub#0
File: .github/instructions/documentation.instructions.md:0-0
Timestamp: 2025-08-21T11:04:26.357Z
Learning: Applies to **/*.mdx : Follow Infrahub naming conventions from the data model and UI consistently
Applied to files:
docs/docs/reference/dotinfrahub.mdx
🪛 LanguageTool
docs/docs/guides/menu.mdx
[style] ~180-~180: Consider a more expressive alternative.
Context: ...sing the git repository integration. To do this, you need to add the menu file to ...
(DO_ACHIEVE)
docs/docs/release-notes/infrahub/release-1_2_1.mdx
[style] ~50-~50: Consider using a different verb for a more formal wording.
Context: ...nfrahub Enterprise. The issue has been fixed in 1.2.1 and the documentation has been...
(FIX_RESOLVE)
docs/docs/topics/check.mdx
[grammar] ~5-~5: Use a hyphen to join words.
Context: --- title: Check --- Checks are user defined logic, stored in an [external re...
(QB_NEW_EN_HYPHEN)
docs/docs/guides/object-load.mdx
[style] ~160-~160: Consider a more expressive alternative.
Context: ...sing the git repository integration. To do this, you need to add the object file t...
(DO_ACHIEVE)
docs/docs/guides/python-transform.mdx
[style] ~458-~458: Consider a more concise word here.
Context: ... to Infrahub](../guides/repository.mdx) in order to sync the repository you created and mak...
(IN_ORDER_TO_PREMIUM)
docs/docs/guides/jinja2-transform.mdx
[style] ~268-~268: Consider a more concise word here.
Context: ... to Infrahub](../guides/repository.mdx) in order to sync the repository you created and mak...
(IN_ORDER_TO_PREMIUM)
docs/docs/guides/repository.mdx
[style] ~16-~16: Consider using an alternative to strengthen your wording.
Context: ...sitory vs. Read-only Repository If you want to know more about the differences betw...
(WANT_KEEN)
docs/docs/guides/check.mdx
[style] ~13-~13: Consider using an alternative to strengthen your wording.
Context: ...info Global vs. Targeted Checks If you want to know more about the differences betw...
(WANT_KEEN)
⏰ 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: validate-generated-documentation
- GitHub Check: documentation
- GitHub Check: Cloudflare Pages
|
|
||
| - Add usage of Towncrier to generate Changelog as part of the release process. | ||
| For detailed information, see the [Documentation](https://docs.infrahub.app/development/changelog). ([#4023](https://github.com/opsmill/infrahub/issues/4023)) | ||
| For detailed information, see the [Documentation](../../development/changelog.mdx). ([#4023](https://github.com/opsmill/infrahub/issues/4023)) |
There was a problem hiding this comment.
🧩 Analysis chain
Verify the target file path is correct and the file exists.
The change converts the documentation link to a relative MDX path. Please confirm that docs/development/changelog.mdx exists and that the relative path ../../development/changelog.mdx correctly resolves to this file from the current location.
🏁 Script executed:
#!/bin/bash
# Verify the target file exists and path is correct
# Current file: docs/docs/release-notes/infrahub/release-0_15_3.mdx
# Relative path: ../../development/changelog.mdx
# Expected resolution: docs/development/changelog.mdx
# Check if target file exists
echo "=== Checking if target file exists ==="
if [ -f "docs/development/changelog.mdx" ]; then
echo "✓ Target file found: docs/development/changelog.mdx"
else
echo "✗ Target file NOT found at: docs/development/changelog.mdx"
fi
# List similar changelog/migration files to understand naming patterns
echo ""
echo "=== Looking for similar documentation files ==="
fd -e mdx changelog
fd -e mdx migration
# Check other release notes to see pattern of link updates
echo ""
echo "=== Sample of other release notes files ==="
fd 'release-.*\.mdx$' docs/docs/release-notes/ | head -5Length of output: 528
Need to verify the relative path is correct across the release notes files.
Need to check if similar link patterns exist in other files to identify whether this is systemic or isolated:
Update the relative path to fix the broken documentation link.
The relative path ../../development/changelog.mdx is incorrect and resolves to docs/development/changelog.mdx, which does not exist. Relative file paths are resolved against the current file's directory. From docs/docs/release-notes/infrahub/release-0_15_3.mdx, the correct path must traverse three directory levels, not two.
Update line 46 to use: ../../../development/changelog.mdx
🤖 Prompt for AI Agents
In docs/docs/release-notes/infrahub/release-0_15_3.mdx around line 46, the
relative link `../../development/changelog.mdx` is wrong (it resolves to
docs/development/changelog.mdx); update it to
`../../../development/changelog.mdx` so it correctly climbs three levels from
the current file, and scan other release-notes files for identical
`../../development/changelog.mdx` patterns and fix them the same way to ensure
links are not broken.
There was a problem hiding this comment.
@petercrocker would be good to double check this one
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
| [separate repository](https://github.com/opsmill/infrahub-sdk-python) and package. | ||
|
|
||
| [Documentation for the SDK](https://docs.infrahub.app/python-sdk/) remains in the main Infrahub documentation at this time. | ||
| [Documentation for the SDK]($(base_url)python-sdk/) remains in the main Infrahub documentation at this time. |
There was a problem hiding this comment.
Verify $(base_url) template syntax compatibility with Docusaurus.
This uses the same $(base_url) syntax as in docs/docs/overview/readme.mdx.old. Standard Docusaurus MDX does not recognize this syntax. Consider using the Docusaurus useBaseUrl hook or standard relative paths instead.
Apply this diff if a relative path is more appropriate:
-[Documentation for the SDK]($(base_url)python-sdk/) remains in the main Infrahub documentation at this time.
+[Documentation for the SDK](/python-sdk/) remains in the main Infrahub documentation at this time.Or use standard Docusaurus imports if dynamic base URL is required:
import useBaseUrl from '@docusaurus/useBaseUrl';
<a href={useBaseUrl('/python-sdk/')}>Documentation for the SDK</a>🤖 Prompt for AI Agents
In docs/docs/release-notes/infrahub/release-0_16_1.mdx around line 37, the
template token "$(base_url)" is not standard MDX/Docusaurus syntax and will not
be resolved; replace the token with either a relative path to the SDK docs (e.g.
"python-sdk/") or use Docusaurus' useBaseUrl hook for dynamic base URL
resolution. If static relative links are fine, update the anchor href to the
correct relative path; if you need the site base URL, import useBaseUrl from
'@docusaurus/useBaseUrl' and change the link to use useBaseUrl('/python-sdk/').
Ensure the final link is valid in the built site.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/docs/guides/artifact.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
docs/docs/guides/**/*.{md,mdx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Write guides in
docs/docs/guides/
Files:
docs/docs/guides/artifact.mdx
docs/**/*.mdx
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use Docusaurus markdown/MDX features in documentation
docs/**/*.mdx: How-to guides should begin title with "How to..." and follow the Diataxis How-to structure (intro, prerequisites, step-by-step, validation, advanced, related)
Use imperative, task-focused instructions in guides; avoid digressions
Topics should use titles like "About..." or "Understanding..." and follow the Diataxis Topics structure (concepts, background, architecture, mental models, connections, alternatives, further reading)
Define new terms on first use; prefer domain-relevant terminology; keep naming consistent with Infrahub UI/data model
Files:
docs/docs/guides/artifact.mdx
docs/**/*
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Develop documentation in
docs/, preview withinvoke docs.build docs.serve, and validate withinvoke docs.validate
Files:
docs/docs/guides/artifact.mdx
**/*.mdx
📄 CodeRabbit inference engine (.github/instructions/documentation.instructions.md)
**/*.mdx: Structure documentation primarily as How-to Guides and Topics (explanations) following the Diataxis framework
Use a professional, approachable tone; avoid jargon unless defined; use plain language with technical precision
Write concise, direct, active sentences
Be informative over promotional; focus on explaining how and why
Maintain consistent, predictable structure across sections and documents
For Guides: use conditional imperatives (e.g., "If you want X, do Y")
For Guides: focus on practical tasks and problems, not tools
For Guides: address the user directly with imperative verbs (e.g., "Configure...", "Create...")
For Guides: keep focus on the specific goal; avoid digressions into explanations
For Guides: title in YAML frontmatter should clearly state the problem and begin with "How to..."
For Guides: include an Introduction stating the problem/goal, context, and what the user will achieve
For Guides: include a Prerequisites/Assumptions section listing requirements and prior knowledge
For Guides: provide step-by-step instructions with numbered steps; include code snippets/screenshots/tabs/callouts as needed
For Guides: include a Validation/Verification section with checks, example outputs, and potential failure points
For Guides: include a Related Resources section linking to relevant guides/topics/reference
For Topics: title in YAML frontmatter should clearly indicate the topic; consider starting with "About..." or "Understanding..."
For Topics: include an Introduction with overview, why it matters, and questions answered
For Topics: include sections for Concepts & Definitions
For Topics: include Background & Context (history, design rationale, constraints)
For Topics: include Architecture & Design details/diagrams when applicable
For Topics: include Mental Models (analogies/comparisons)
For Topics: connect to other concepts and integration points
For Topics: include Alternative Approaches with pros/cons where relevant
For Topics: include a Further...
Files:
docs/docs/guides/artifact.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
Lint Markdown/MDX files with markdownlint using
.markdownlint.yaml
Files:
docs/docs/guides/artifact.mdx
docs/!(node_modules)/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
docs/!(node_modules)/**/*.{md,mdx}: Lint documentation prose with Vale
Ensure Vale style checks pass for documentation
Files:
docs/docs/guides/artifact.mdx
⏰ 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: validate-generated-documentation
- GitHub Check: documentation
- GitHub Check: Cloudflare Pages
| - name: "Device configuration file" | ||
| artifact_name: "device_configuration" |
There was a problem hiding this comment.
🧩 Analysis chain
Verify field semantics: name and artifact_name values appear reversed relative to their descriptions.
Lines 70–71 show:
name: "Device configuration file"(human-readable, contains spaces)artifact_name: "device_configuration"(machine identifier, no spaces)
However, lines 81–82 describe these fields as:
**name**: Machine identifier (no spaces)**artifact_name**: Human-readable label
The example contradicts its own documentation. Either the field values in the YAML snippet are swapped, or the descriptions are incorrect.
Please confirm which is correct:
- The field values should be swapped (name →
"device_configuration", artifact_name →"Device configuration file"), or - The field descriptions should be updated to match the current example.
Verify this against the Infrahub schema and .infrahub.yml reference documentation to ensure consistency.
Also applies to: 81-82
---
🏁 Script executed:
```shell
#!/bin/bash
# View the artifact.mdx file at the relevant line ranges
echo "=== Lines 65-75 (example snippet) ==="
sed -n '65,75p' docs/docs/guides/artifact.mdx
echo ""
echo "=== Lines 78-85 (field descriptions) ==="
sed -n '78,85p' docs/docs/guides/artifact.mdx
Length of output: 641
🏁 Script executed:
#!/bin/bash
# Search for artifact_name and name field definitions in schema or reference docs
echo "=== Searching for artifact_name field definitions ==="
rg -n "artifact_name" docs/ -A2 -B2 --type=mdx --type=md | head -40
echo ""
echo "=== Searching for name field in artifact context ==="
rg -n "artifact.*name.*machine|identifier.*no.*space" docs/ -i --type=mdx --type=mdLength of output: 163
🏁 Script executed:
#!/bin/bash
# Check for other artifact examples in documentation
echo "=== Other artifact examples in guides ==="
rg -n "artifact_name.*:" docs/docs/guides/ -A1 -B1 --type=mdx | head -30Length of output: 69
🏁 Script executed:
#!/bin/bash
# Search for schema or reference files that define artifact structure
fd -e yml -e yaml -e json . docs/ | xargs rg -l "artifact" 2>/dev/null | head -10Length of output: 0
🏁 Script executed:
#!/bin/bash
# Search for other artifact examples without type specification
echo "=== Other artifact_name examples in documentation ==="
grep -rn "artifact_name" docs/docs/ -A1 -B1 | head -40Length of output: 1682
🏁 Script executed:
#!/bin/bash
# Search for Python schema or pydantic models defining artifacts
echo "=== Searching for artifact schema definitions in Python ==="
find . -name "*.py" -type f | xargs grep -l "artifact_name" 2>/dev/null | grep -v __pycache__ | head -10Length of output: 456
🏁 Script executed:
#!/bin/bash
# Check for infrahub.yml reference or schema documentation
echo "=== Looking for infrahub-yml reference or schema docs ==="
find docs/ -name "*infrahub*" -type fLength of output: 765
🏁 Script executed:
#!/bin/bash
# Search for artifact in schema or model files
echo "=== Searching schema files for artifact field definitions ==="
find . -path ./node_modules -prune -o -name "*.json" -type f -print | xargs grep -l "artifact" 2>/dev/null | head -5Length of output: 157
🏁 Script executed:
#!/bin/bash
# Look at the topic file that describes infrahub.yml
echo "=== Content of infrahub-yml topic (if exists) ==="
[ -f docs/docs/topics/infrahub-yml.mdx ] && grep -n "artifact" docs/docs/topics/infrahub-yml.mdx -A3 -B3 | head -50Length of output: 1033
🏁 Script executed:
#!/bin/bash
# Examine the Python artifact schema definition to confirm field semantics
echo "=== Artifact schema Python definition ==="
head -100 ./backend/infrahub/core/schema/definitions/core/artifact.py | grep -n "name\|artifact_name" -A2 -B2Length of output: 1988
🏁 Script executed:
#!/bin/bash
# Search for documentation on artifact field meanings in schema file
cat ./backend/infrahub/core/schema/definitions/core/artifact.py | head -200Length of output: 3953
Fix field descriptions: name and artifact_name descriptions in lines 81–82 are reversed and contradict the schema and example.
Lines 81–82 currently state:
**name**: Machine identifier (no spaces)**artifact_name**: Human-readable label
However, the Python schema, reference documentation, and the example above (lines 70–71) confirm the opposite:
name: Name of the artifact definition (e.g., "Device configuration file")artifact_name: Name of the generated artifact—machine identifier with no spaces (e.g., "device_configuration")
Update lines 81–82 to:
**name**: Name of the artifact definition**artifact_name**: Machine identifier for the generated artifact (no spaces)
This aligns with the example, the reference schema, and the 1.1.5 release notes stating artifacts now use artifact_name instead of the definition name.
🤖 Prompt for AI Agents
In docs/docs/guides/artifact.mdx around lines 81–82, the descriptions for `name`
and `artifact_name` are reversed; update those two lines so that `name` reads
"Name of the artifact definition" and `artifact_name` reads "Machine identifier
for the generated artifact (no spaces)" to match the example, schema, and
release notes.
|
|
||
| - Add usage of Towncrier to generate Changelog as part of the release process. | ||
| For detailed information, see the [Documentation](https://docs.infrahub.app/development/changelog). ([#4023](https://github.com/opsmill/infrahub/issues/4023)) | ||
| For detailed information, see the [Documentation](../../development/changelog.mdx). ([#4023](https://github.com/opsmill/infrahub/issues/4023)) |
There was a problem hiding this comment.
@petercrocker would be good to double check this one
* fix bad links 1 * fix links * more link fixes * fix links in templates * remove duplicate * fix artifact_definitions Co-authored-by: Pete Crocker <[email protected]>
Added
.mdxon the end of links to fix lychee and file path validationsSummary by CodeRabbit
Documentation
Bug Fixes
New Features