1dabb5110f
docs(help): bring the user guide back in line with the current app The help was written on 2026-10-14 and about forty user-visible changes merged since without touching it, so several pages described controls that no longer exist: Missions still listed four playbooks and a Save step for preferences that now save on each change, the depth editor kept its old names, notifications still had their former switches, and voice input pointed to a microphone button that is not in the composer. Every English page was re-checked claim by claim against the current labels (English UI messages) and behaviour, then the nine translations were updated to match, using each locale's own UI labels. Notable corrections: Missions (Compare two models, autosaving defaults with Apply to / Global / Reset, Subsession nesting depth, prepared hand-offs, retired-task interrupts, the named causes of "Mission Control is unavailable", standalone server support); conversations and history (reasoning/tool durations, token lines adding up the cleanup selection, presets including Nothing, timeline markers following Message content, in-place reveal of long text, Open in session, focus after send, Queue message / Steer now, Retrying); settings (notification routing table and defaults, Stats, Mode, info tips, Server setting badge, localized native menus); shortcuts (72 actions, Clear shortcut, Ctrl/Cmd+K); voice (More actions entries, Save status); files (live Workspace refresh, Show 200 more); OpenCode, install, server and updates (2.1.1 recommended, OpenCode 2 beside an older installation, version card first, private loopback listener for Missions, preview releases offered once all builds are published); providers, integrations, browser, SideCars, desktop and remote pages. Translations also repaired older drift, mainly the project-tab closing passages. The Chat settings table header (Default state, its title, item column, the thinking row and its accessible label) was still English in eight locales; it is now translated so the help can cite what users see. AGENTS.md now asks every PR changing user-visible behavior to update the affected help pages in the same PR, since CI validates structure and links but not whether the text still matches the UI; it also corrects the needs-input notification default. USER_HELP.md no longer claims native menus stay English. Validation: npm run test:help (all ten locales, 25 pages, heading ids unchanged), a full help build, and the i18n and transcript-visibility unit tests.
8.5 KiB
Поддержка и сборка из исходников
Используйте репозиторий для сообщений об ошибках, текущих релизов и вклада в проект. Руководство по устранению неполадок описывает безопасное восстановление до сообщения о проблеме.
Сообщение об ошибке
- Откройте Настройки → Информация → Диагностика.
- Выберите Сообщить об ошибке для открытия формы задачи GitHub.
- Проверьте предзаполненную информацию версии/клиента. Добавьте минимальное воспроизведение, ожидаемое поведение и фактический результат, затем отправьте через GitHub.
Действие заполняет версии CodeNomad и OpenCode (включая работающую службу OpenCode, если её версия отличается от установленной), вашу операционную систему, тип клиента (с user agent браузера в веб-браузере) и операционную систему сервера. Оно не заполняет адреса слушателей, пути рабочего пространства, учётные данные или текст разговоров. Открытие формы не отправляет задачу.
Если нужна дополнительная диагностика, Скопировать в буфер обмена или Скачать .txt создаёт отдельный отчёт. Более полный отчёт может содержать локальные пути и сетевые адреса: проверьте и очистите перед прикреплением. Снимок экрана или фрагмент лога тоже может содержать секреты, даже если автоматический отчёт исключает секреты аутентификации.
Если форма GitHub имеет несовместимые поля, CodeNomad открывает обычную задачу с той же информацией отчёта. Временная ошибка чтения формы не мешает открытию. Всегда можно вручную использовать список задач.
Сообщество и релизы
| Ресурс | Применение |
|---|---|
| Репозиторий CodeNomad | Исходники, активность проекта и документация. |
| Задачи | Поищите существующие отчёты перед воспроизводимой ошибкой или запросом функции. |
| Pull requests | Проверяйте предлагаемые изменения или согласуйте вклад. |
| Последний релиз | Стабильные файлы загрузки. |
| Все релизы | Опубликованные предварительные версии и примечания. |
| Neural Nomads | Организация проекта. |
| Лицензия MIT | Условия лицензии. |
По вопросам нативной конфигурации OpenCode, а не управления CodeNomad, обратитесь к документации OpenCode и релизам upstream.
Сборка из исходников
Используйте Node.js 24.20.0, закреплённый в .node-version, npm, Git и совместимый OpenCode CLI. Выполните команды из рабочей копии разработки:
git clone --branch dev https://github.com/NeuralNomadsAI/CodeNomad.git
cd CodeNomad
npm ci --workspaces --include=optional
npm run dev
npm run dev запускает хост разработки Electron. Для Tauri сначала установите предпосылки сборки платформы, включая Rust, затем выполните:
npm run dev:tauri
Изменения разработки влияют на хост разработки, не на установленную версию независимо работающего демона OpenCode. Нативная упаковка требует соответствующих целевых инструментов; предпочитайте сборку на целевой ОС.
Сборка и проверка
| Команда из корня репозитория | Назначение |
|---|---|
npm run build |
Собрать ресурсы приложения Electron. |
npm run build:tauri |
Собрать приложение Tauri с его нативными предпосылками. |
npm run build:ui |
Собрать браузерный интерфейс. |
npm run build --workspace @neuralnomads/codenomad |
Собрать отдельный сервер и встроенные ресурсы. |
npm run build:linux --workspace @neuralnomads/codenomad-electron-app |
Упаковать релиз Electron Debian. |
npm exec --workspace @codenomad/tauri-app -- tauri build --bundles appimage |
Упаковать Linux Tauri AppImage. |
npm run typecheck |
Проверить настроенные TypeScript-пространства корня. |
npm run test:help |
Проверить все локали общедоступной справки и ссылки. |
npm run build:help |
Собрать отдельную общедоступную справку в dist/help. |
Сборке справки не нужна работающая служба CodeNomad или OpenCode. Упаковка описана в BUILD.md, проверки по областям и правила PR — в CONTRIBUTING.md; используйте реально существующие сценарии целевого пакета.
Карта пакетов и вклад
| Пакет | Ответственность |
|---|---|
packages/server |
Управление рабочими пространствами/API/Git, подключение OpenCode, аутентификация, события и речь. |
packages/ui |
Рабочее пространство SolidJS, элементы управления, локализация и вход браузерной справки. |
packages/electron-app |
Окна Electron, нативная интеграция и упаковка. |
packages/tauri-app |
Окна Tauri, интеграция платформы и упаковка. |
packages/remote-tunnel |
Среда транспорта OpenTunnel серверной стороны. |
- Обсудите область в соответствующей задаче перед реализацией пересекающейся работы.
- Создайте ветку от
devи сохраняйте фокус изменения. - Выполните проверки затронутой области, обновите справку вместе с поведением и направьте PR в
dev.
Исходники общедоступной справки находятся в docs/help/<locale>/. Сохраняйте явный ID, уровень и порядок каждого английского заголовка в переводах; переведённые заголовки не должны ломать глубокие ссылки. Контракт сопровождения справки описывает строгую полноту и конвейер статической публикации.