<< All versions
Skill v1.0.0
currentAutomated scan100/100syntaxarc/archipy-plugin/archipy-docs
──Details
PublishedSeptember 27, 2026 at 06:58 PM
Content Hashsha256:97d994271da02fec...
Git SHAbe5408e5ac9d
──Files
Files (1 file, 3.1 KB)
SKILL.md3.1 KBactive
SKILL.md · 45 lines · 3.1 KB
version: "1.0.0" name: archipy-docs description: >- Answer how-to questions about ArchiPy 5.x in an app (config, DI, adapters, helpers, errors, layout, observability) from the bundled reference and live docs. Use for "how do I … with archipy", "which extra/adapter/decorator", or API questions.
ArchiPy Docs Lookup
Procedure
- Determine the app's installed ArchiPy major version from
pyproject.tomloruv.lockwhen available. - For version-sensitive topics (extras, observability, decorators, interceptors), consult the matching live doc first.
- Read
reference.mdin this skill directory (version, install, layout, and a topic index), then only the matching
reference/<topic>.md; it targets ArchiPy 5.x. For older apps, explain migration differences instead of recommending removed APIs.
- Answer concisely and link the matching live doc:
| Topic | URL | |
|---|---|---|
| Docs home | https://syntaxarc.github.io/ArchiPy/ | |
| Quickstart | https://syntaxarc.github.io/ArchiPy/getting-started/quickstart/ | |
| Project structure | https://syntaxarc.github.io/ArchiPy/getting-started/project_structure/ | |
| Adapters | https://syntaxarc.github.io/ArchiPy/tutorials/adapters/ | |
| Helpers | https://syntaxarc.github.io/ArchiPy/tutorials/helpers/ | |
| Config | https://syntaxarc.github.io/ArchiPy/tutorials/config_management/ | |
| DI | https://syntaxarc.github.io/ArchiPy/tutorials/dependency_injection/ | |
| Health checks | Bundled reference/health-checks.md (HTTP + gRPC) + /scaffold-health-checks | |
| Models / DTOs | Bundled reference.md § DTO naming + /scaffold-models | |
| Errors | https://syntaxarc.github.io/ArchiPy/tutorials/error_handling/ + /scaffold-models | |
| Testing | https://syntaxarc.github.io/ArchiPy/tutorials/testing_strategy/ + /scaffold-bdd | |
| Observability | Bundled reference/observability.md + https://syntaxarc.github.io/ArchiPy/tutorials/observability/ | |
| Redis search | Bundled reference/adapters.md + /redis-search | |
| API reference | https://syntaxarc.github.io/ArchiPy/api_reference/ |
- Prefer PyPI
archipyAPIs — do not assume the ArchiPy monorepo is on disk.
Output
- Short, actionable answer with a code sketch when useful
- Link to live docs for deep dives
- Suggest the matching
/scaffold-*or/docs-*command when scaffolding is the next step