Skip to content

Commit f186180

Browse files
authored
Merge pull request #857 from opsmill/develop
Merge develop into infrahub-develop
2 parents 1c1407d + bd27571 commit f186180

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ uv sync --all-groups --all-extras # Install all deps
99
uv run invoke format # Format code
1010
uv run invoke lint # Full pipeline: ruff, yamllint, ty, mypy, markdownlint, vale
1111
uv run invoke lint-code # All linters for Python code
12+
uv run invoke docs-generate # Generate all docs (CLI + SDK)
13+
uv run invoke docs-validate # Check generated docs match committed version
1214
uv run pytest tests/unit/ # Unit tests
1315
uv run pytest tests/integration/ # Integration tests
1416
```
@@ -54,7 +56,7 @@ Key rules:
5456
**Always**
5557

5658
- Run `uv run invoke format lint-code` before committing Python code
57-
- Run `uv run invoke generate-sdk generate-infrahubctl` after changing CLI commands or SDK config
59+
- Run `uv run invoke docs-generate` after creating, modifying or deleting CLI commands, SDK config, or Python docstrings
5860
- Run markdownlint before committing markdown changes
5961
- Follow async/sync dual pattern for new features
6062
- Use type hints on all function signatures

docs/AGENTS.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,7 @@ Use callouts for important notes.
6666

6767
🚫 **Never**
6868

69-
- Edit `docs/infrahubctl/*.mdx` directly (regenerate with `uv run invoke generate-infrahubctl`)
70-
- Edit `docs/python-sdk/reference/config.mdx` directly (regenerate with `uv run invoke generate-sdk`)
69+
- Edit `docs/infrahubctl/*.mdx` directly (regenerate with `uv run invoke docs-generate`)
70+
- Edit `docs/python-sdk/reference/config.mdx` directly (regenerate with `uv run invoke docs-generate`)
71+
- Edit `docs/python-sdk/reference/templating.mdx` directly (regenerate with `uv run invoke docs-generate`)
72+
- Edit `docs/python-sdk/sdk_ref/**/*.mdx` directly (regenerate with `uv run invoke docs-generate`)

0 commit comments

Comments
 (0)