33 lines
3.0 KiB
Plaintext
33 lines
3.0 KiB
Plaintext
- Всегда используй навык koda-zensical
|
||
- Всегда перечитывай файлы перед каждым изменением - пользователь уже мог внести изменения
|
||
- При изменениях структуры проекта всегда актуализируй AGENTS.md
|
||
- |
|
||
В структуре навигации файла `zensical.toml` всегда должен присутствовать закомментированный раздел `Debug`.
|
||
Это отладочные страницы с примерами, которые не должны попасть в итоговую документацию.
|
||
Этот раздел раскомментируется вручную по необходимости.
|
||
- |
|
||
Для отладки используй команду `make site`.
|
||
В выводе команды могу быть предупреждения и ошибки в следующем формате:
|
||
|
||
```
|
||
Warning: page does not exist
|
||
╭─[ test.md:695:10 ]
|
||
│
|
||
695 │ - [Edit](../edit/how-to-use-it.md) — редактирование кода
|
||
│ ────────────┬───────────
|
||
│ ╰───────────── page does not exist
|
||
─────╯
|
||
```
|
||
что означает буквально следующее: "в файле content/test.md в строке 695 в позиции 10 есть ссылка на несуществующую страницу."
|
||
Эти предупреждения надо всегда исправлять.
|
||
|
||
- При изменениях структуры проекта и только при корректной сборке (без предупреждений и ошибок) всегда актуализируй `./AGENTS.md`
|
||
- При доработке или расширении функционала этого проекта или синтаксиса всегда актуализируй скилл `./.agents/skills/koda-zensical`
|
||
- Аргументы `iptvc` должны быть в lower-kebab-case с префиксом `--` (`--playlists-all-cooldown`)
|
||
- Параметры конфига `iptvc`, состоящие из нескольких слов, должны быть в camelCase (check.playlists.allCooldown)
|
||
- Переменные окружения `iptvc` должны быть в UPPER_SNAKE_CASE (`CHECK_PLAYLISTS_ALL_COOLDOWN`)
|
||
- Заголовки документации и шорткоды `<!-- md:... ... -->` должны содержать описываемые сущности как есть
|
||
- ID заголовоков должны быть в lower-kebab-case, точки и `_` заменяются на `-` (## `check.playlists.all-cooldown` { id=check-playlists-all-cooldown })
|
||
- Обязательно используй шорткоды `<!-- md:config ... -->` для ссылок на документацию параметров конфига
|
||
|