diff --git a/docs/ai-assisted-development.md b/docs/ai-assisted-development.md index a7173629..fe131298 100644 --- a/docs/ai-assisted-development.md +++ b/docs/ai-assisted-development.md @@ -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: @@ -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 diff --git a/docs/usage.md b/docs/usage.md index 707c96cd..5dd6f4ae 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -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). diff --git a/zensical.toml b/zensical.toml index 9e76ea6c..9733b7e9 100644 --- a/zensical.toml +++ b/zensical.toml @@ -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]