Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion docs/ai-assisted-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Pick your tool below for CorridorKey-specific setup instructions.

=== "Kiro"

Kiro uses **steering files** stored in `.kiro/steering/*.md` to
[Kiro](https://kiro.dev) uses **steering files** stored in `.kiro/steering/*.md` to
provide persistent project context. Each file is a Markdown
document that Kiro loads according to one of three inclusion
modes:
Expand Down Expand Up @@ -151,6 +151,34 @@ Pick your tool below for CorridorKey-specific setup instructions.
`VideoMaMaInferenceModule/`.
```

**Quick-start prompt:** Instead of setting everything up
manually, paste this into Kiro chat to have it clone the repo,
read `AGENTS.md`, and scaffold steering files, hooks, and skills
for you automatically:

```text
Clone https://github.com/nikopueringer/CorridorKey.git and open
the workspace. Read AGENTS.md and docs/LLM_HANDOVER.md, then:

1. Create a .kiro/steering/corridorkey-context.md steering file
that summarises the project rules, key file map, dev commands,
and prohibited actions from AGENTS.md. Set it to always-on.

2. Create a .kiro/steering/color-pipeline.md conditional steering
file (fileMatch: "**/color_utils.py") that covers the sRGB
transfer function rules and EXR pipeline math from
LLM_HANDOVER.md.

3. Create agent hooks:
- A postToolUse hook on write tools that reminds you to run
`uv run ruff check` after editing Python files.
- A fileEdited hook on *.py that runs `uv run ruff format
--check` to catch formatting drift.

4. Run `uv sync --group dev` to set up the dev environment, then
`uv run pytest -m "not gpu"` to verify everything passes.
```

=== "Claude Code"

Claude Code loads a **`CLAUDE.md`** file from the repository root
Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Two optional modules are bundled for automatic hint generation inside
If you choose VideoMaMa, place your mask hint in the `VideoMamaMaskHint/`
folder that the wizard creates for your shot.

!!! note "Show these projects some love"
!!! star "Show these projects some love"
GVM and VideoMaMa are open-source research projects. Please star their
repos: [VideoMaMa](https://github.com/cvlab-kaist/VideoMaMa) and
[GVM](https://github.com/aim-uofa/GVM).
Expand Down
3 changes: 3 additions & 0 deletions zensical.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

[project.theme.icon.admonition]
star = "material/star"

[project.markdown_extensions.attr_list]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.pymdownx.emoji]
Expand Down