Conversation
github-actions
bot
added
the
type/documentation
WalkthroughThe change adds a new development setup guide documentation file that covers prerequisites, project generation from templates, starting a local Infrahub instance, obtaining and loading schema libraries, using the infrahubctl tool, development best practices, and next steps. The documentation sidebar configuration is updated to include a reference to this new guide page in the Installation & Setup section under Guides. 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/docs/guides/development-setup.mdx`:
- Around line 42-44: Replace the non-standard Docusaurus admonition token
":::success" with the supported ":::tip[Verification]" for all three occurrences
(the blocks beginning with ":::success" around the verification text at the
three noted locations) so the docs use a built-in admonition type; ensure you
update the opening token exactly to ":::tip[Verification]" and leave the inner
content and closing ":::” block unchanged.
- Line 23: Replace the unstable feature-branch reference in the copier command
by removing or replacing the "-r bgi-invoke-schema-library" flag with a stable
tag (e.g., "-r v0.0.1") or omit the flag to use the default branch so the
command "uv tool run --from 'copier' copier copy -r bgi-invoke-schema-library
https://github.com/opsmill/infrahub-template <project-name>" no longer points at
a transient branch; also replace all nonstandard Docusaurus admonitions
":::success" with a supported type such as ":::tip" or ":::info" so the docs
build correctly.
| 1. Run the following command to create a new project: | ||
|
|
||
| ```bash | ||
| uv tool run --from 'copier' copier copy -r bgi-invoke-schema-library https://github.com/opsmill/infrahub-template <project-name> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
git ls-remote --heads --tags https://github.com/opsmill/infrahub-template 2>/dev/null | head -40Repository: opsmill/infrahub
Length of output: 252
🌐 Web query:
Docusaurus admonition types supported versions
💡 Result:
Default admonition types by Docusaurus version
- Docusaurus 2.x (docs):
note,tip,info,caution,danger(these are also the acceptedtypevalues for@theme/Admonition). [1] - Docusaurus 3.x (and “next”):
note,tip,info,warning,danger(these are also the acceptedtypevalues for@theme/Admonition). [2][3]
Notable change (v2 → v3)
:::cautionis deprecated in v3; you’re expected to migrate to:::warning(yellow) or:::danger(red). [4]:::warningexisted for historical reasons in v2 but was undocumented (and had historically “wrong” styling); v3 makeswarningofficial and fixes its styling. [5]
Custom types
You can add custom admonition keywords/types via the admonitions.keywords config (and provide rendering support for new types). [2]
Sources:
[1] Docusaurus 2.x Admonitions docs (docusaurus.io)
[2] Docusaurus 3.8.1 Admonitions docs (docusaurus.io)
[3] Docusaurus “next” Admonitions docs (docusaurus.io)
[4] Docusaurus v3 migration guide (admonitions caution deprecation) (docusaurus.io)
[5] “Preparing your site for Docusaurus v3” (warning/caution notes) (docusaurus.cn)
Citations:
- 1: https://docusaurus.io/docs/2.x/markdown-features/admonitions
- 2: https://www.docusaurus.io/docs/3.8.1/markdown-features/admonitions?utm_source=openai
- 3: https://docusaurus.io/docs/next/markdown-features/admonitions?utm_source=openai
- 4: https://docusaurus.io/docs/3.2.1/migration/v3?utm_source=openai
- 5: https://www.docusaurus.cn/blog/preparing-your-site-for-docusaurus-v3?utm_source=openai
Replace the feature branch reference with a stable tag or default.
The -r bgi-invoke-schema-library flag references a feature branch that will be deleted after this PR merges. Use a stable tag (e.g., v0.0.1) or omit the flag to default to the main branch:
diff
- uv tool run --from 'copier' copier copy -r bgi-invoke-schema-library https://github.com/opsmill/infrahub-template <project-name>
+ uv tool run --from 'copier' copier copy https://github.com/opsmill/infrahub-template <project-name>Additionally, :::success is not a standard Docusaurus admonition type. Replace with :::tip or :::info (lines 42, 62, 110).
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| uv tool run --from 'copier' copier copy -r bgi-invoke-schema-library https://github.com/opsmill/infrahub-template <project-name> | |
| uv tool run --from 'copier' copier copy https://github.com/opsmill/infrahub-template <project-name> |
🤖 Prompt for AI Agents
In `@docs/docs/guides/development-setup.mdx` at line 23, Replace the unstable
feature-branch reference in the copier command by removing or replacing the "-r
bgi-invoke-schema-library" flag with a stable tag (e.g., "-r v0.0.1") or omit
the flag to use the default branch so the command "uv tool run --from 'copier'
copier copy -r bgi-invoke-schema-library
https://github.com/opsmill/infrahub-template <project-name>" no longer points at
a transient branch; also replace all nonstandard Docusaurus admonitions
":::success" with a supported type such as ":::tip" or ":::info" so the docs
build correctly.
| :::success Verification | ||
| Your project directory should contain files like `pyproject.toml`, `invoke.yaml`, and a `schemas/` folder. | ||
| ::: |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Docusaurus admonition types supported documentation
💡 Result:
Docusaurus’ built-in admonition types (the labels you can use after :::) are documented as:
- Docusaurus v3 (current line):
note,tip,info,warning,danger([1]) - Docusaurus v2.x:
note,tip,info,caution,danger([2])
You can also register additional/custom types by configuring the admonitions plugin keywords in docusaurus.config.js ([1], [2]).
Sources: [1] [2]
🏁 Script executed:
# Check the file content at the specified lines
cat -n docs/docs/guides/development-setup.mdx | sed -n '35,50p'Repository: opsmill/infrahub
Length of output: 493
🏁 Script executed:
# Search for all :::success occurrences in the file
rg ':::success' docs/docs/guides/development-setup.mdx -nRepository: opsmill/infrahub
Length of output: 141
🏁 Script executed:
# Check if there are any custom admonition configurations
rg -i 'success' docs/docs/guides/development-setup.mdx -A 2 -B 2Repository: opsmill/infrahub
Length of output: 538
:::success is not a standard Docusaurus admonition type and will cause build warnings or rendering failures.
Docusaurus v3 supports only note, tip, info, warning, and danger as built-in admonition types. Custom types require explicit configuration in docusaurus.config.js. All three occurrences (lines 42, 62, and 110) must be updated.
Switch to :::tip[Verification], which is semantically appropriate for verification steps that follow major actions.
Proposed fix (apply to all three occurrences)
-:::success Verification
+:::tip[Verification]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :::success Verification | |
| Your project directory should contain files like `pyproject.toml`, `invoke.yaml`, and a `schemas/` folder. | |
| ::: | |
| :::tip[Verification] | |
| Your project directory should contain files like `pyproject.toml`, `invoke.yaml`, and a `schemas/` folder. | |
| ::: |
🤖 Prompt for AI Agents
In `@docs/docs/guides/development-setup.mdx` around lines 42 - 44, Replace the
non-standard Docusaurus admonition token ":::success" with the supported
":::tip[Verification]" for all three occurrences (the blocks beginning with
":::success" around the verification text at the three noted locations) so the
docs use a built-in admonition type; ensure you update the opening token exactly
to ":::tip[Verification]" and leave the inner content and closing ":::” block
unchanged.
1 participant
Summary by CodeRabbit