|
2 | 2 |
|
3 | 3 | Ansible collection — modules, plugins, and inventory sources for [Infrahub](https://github.com/opsmill/infrahub), an infrastructure data platform. |
4 | 4 |
|
| 5 | +This file is the portable router: repo-wide facts every agent needs up front. Deeper how-tos, architecture notes, and decision records live under [dev/](dev/) — see Navigation below. |
| 6 | + |
5 | 7 | - **Namespace / Collection:** `opsmill.infrahub` · **License:** GPLv3 |
6 | 8 | - **Repo:** <https://github.com/opsmill/infrahub-ansible> · **Docs:** <https://docs.infrahub.app/ansible/> |
7 | 9 | - **Constitution (binding principles):** [.specify/memory/constitution.md](.specify/memory/constitution.md) |
8 | 10 | - **Dev docs index:** [dev/README.md](dev/README.md) · **Decision records:** [dev/adr/](dev/adr/) |
9 | 11 |
|
| 12 | +## Navigation |
| 13 | + |
| 14 | +Internal developer docs are indexed in [dev/README.md](dev/README.md): architecture in [dev/knowledge/](dev/knowledge/) ([architecture](dev/knowledge/architecture.md), [plugin-patterns](dev/knowledge/plugin-patterns.md), [infrahub-sdk-usage](dev/knowledge/infrahub-sdk-usage.md)), how-to guides in [dev/guides/](dev/guides/) ([creating-a-module](dev/guides/creating-a-module.md), [running-tests](dev/guides/running-tests.md)), coding rules in [dev/guidelines/](dev/guidelines/) ([python](dev/guidelines/python.md), [testing](dev/guidelines/testing.md), [documentation](dev/guidelines/documentation.md), [git-workflow](dev/guidelines/git-workflow.md)), decisions in [dev/adr/](dev/adr/), binding principles in [.specify/memory/constitution.md](.specify/memory/constitution.md), and agent commands in [.agents/commands/](.agents/commands/). |
| 15 | + |
| 16 | +## File Structure |
| 17 | + |
| 18 | +```text |
| 19 | +plugins/modules/ Module stubs (DOCUMENTATION + AnsibleModule) |
| 20 | +plugins/action/ Action plugins (controller-side logic) |
| 21 | +plugins/module_utils/ Core shared code (infrahub_utils, node, branch, exception) |
| 22 | +plugins/inventory/ Dynamic inventory plugin |
| 23 | +plugins/lookup/ GraphQL lookup plugin |
| 24 | +plugins/doc_fragments/ Reusable DOCUMENTATION fragments |
| 25 | +tests/ Unit + integration + sanity tests |
| 26 | +docs/ Docusaurus site + generated plugin reference |
| 27 | +dev/ Internal developer docs (knowledge, guides, guidelines, adr) |
| 28 | +.agents/ Portable agent sources (commands, skills) |
| 29 | +.specify/ Spec-kit (constitution, templates, workflows) |
| 30 | +.claude/ Claude Code adapter (settings, symlinked commands) |
| 31 | +``` |
| 32 | + |
10 | 33 | ## Tech Stack |
11 | 34 |
|
12 | 35 | | Component | Version/Tool | |
|
0 commit comments