红尘
d73ff9b0fb
Deploy Site / deploy-vercel (push) Has been cancelled
Deploy Site / deploy-docs (push) Has been cancelled
Docker / shell lint / Lint Dockerfile (hadolint) (push) Has been cancelled
Docker / shell lint / Lint docker/ shell scripts (shellcheck) (push) Has been cancelled
Docker Build and Publish / build-amd64 (push) Has been cancelled
Docker Build and Publish / build-arm64 (push) Has been cancelled
Lint (ruff + ty) / ruff + ty diff (push) Has been cancelled
Lint (ruff + ty) / ruff enforcement (blocking) (push) Has been cancelled
Lint (ruff + ty) / Windows footguns (blocking) (push) Has been cancelled
Nix Lockfile Fix / auto-fix-main (push) Has been cancelled
Nix Lockfile Fix / fix (push) Has been cancelled
Nix / nix (macos-latest) (push) Has been cancelled
Nix / nix (ubuntu-latest) (push) Has been cancelled
OSV-Scanner / Scan lockfiles (push) Has been cancelled
Build Skills Index / build-index (push) Has been cancelled
Tests / test (1) (push) Has been cancelled
Tests / test (2) (push) Has been cancelled
Tests / test (3) (push) Has been cancelled
Tests / test (4) (push) Has been cancelled
Tests / test (5) (push) Has been cancelled
Tests / test (6) (push) Has been cancelled
Tests / e2e (push) Has been cancelled
uv.lock check / uv lock --check (push) Has been cancelled
Docker Build and Publish / merge (push) Has been cancelled
Build Skills Index / trigger-deploy (push) Has been cancelled
Tests / save-durations (push) Has been cancelled
39 lines
634 B
Markdown
39 lines
634 B
Markdown
# Module: `{{MODULE_NAME}}`
|
|
|
|
{{ONE_TO_TWO_SENTENCE_PURPOSE}}
|
|
|
|
## Responsibilities
|
|
|
|
- {{BULLET_1}}
|
|
- {{BULLET_2}}
|
|
- {{BULLET_3}}
|
|
|
|
## Key Files
|
|
|
|
- [`{{PATH_1}}`]({{LINK_1}}) — {{WHAT_IT_DOES}}
|
|
- [`{{PATH_2}}`]({{LINK_2}}) — {{WHAT_IT_DOES}}
|
|
|
|
## Public API
|
|
|
|
### `{{FUNCTION_NAME}}({{SIGNATURE}})`
|
|
|
|
{{ONE_LINE_DESCRIPTION}}
|
|
|
|
**Parameters:**
|
|
- `{{PARAM}}` ({{TYPE}}) — {{DESCRIPTION}}
|
|
|
|
**Returns:** {{TYPE}} — {{DESCRIPTION}}
|
|
|
|
## Internal Structure
|
|
|
|
{{HOW_THE_MODULE_IS_ORGANIZED}}
|
|
|
|
## Dependencies
|
|
|
|
- **Used by:** {{OTHER_MODULES}}
|
|
- **Uses:** {{OTHER_MODULES_AND_LIBS}}
|
|
|
|
## Notable Patterns / Gotchas
|
|
|
|
- {{ANYTHING_NON_OBVIOUS}}
|