mirror of https://github.com/NeuralNomadsAI/CodeNomad.git synced 2026-10-23 14:51:18 +00:00

docs(help): bring the user guide back in line with the current app (#1079 )

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.

2026-10-21 14:38:29 +02:00

5.9 KiB

Raw Permalink Blame History

Support und Quellcode-Builds

Verwenden Sie das Repository für Fehlerberichte, aktuelle Releases und Beiträge. Die Fehlerbehebung beschreibt sichere Wiederherstellung vor einer Meldung.

Fehler melden

Öffnen Sie Einstellungen → Info → Diagnose.
Wählen Sie Fehler melden, um das GitHub-Issue-Formular zu öffnen.
Prüfen Sie vorausgefüllte Versions-/Clientinformationen. Ergänzen Sie eine minimale Reproduktion, erwartetes Verhalten und tatsächliches Ergebnis und senden Sie dann über GitHub ab.

Die Aktion füllt die Versionen von CodeNomad und OpenCode (einschließlich des laufenden OpenCode-Dienstes, wenn er von der installierten Version abweicht), Ihr Betriebssystem, den Clienttyp (in einem Webbrowser mit dessen User-Agent) und das Betriebssystem des Servers vorab aus. Listeneradressen, Arbeitsbereichspfade, Zugangsdaten und Unterhaltungstext werden nicht vorausgefüllt. Formularöffnen ist noch keine Meldung.

Benötigen Sie mehr Diagnosen, erzeugen In Zwischenablage kopieren oder .txt herunterladen einen separaten Bericht. Dieser ausführlichere Bericht kann lokale Pfade und Netzwerkadressen enthalten: Prüfen und schwärzen Sie ihn vor dem Anhängen. Screenshots oder Log-Auszüge können weiterhin Geheimnisse enthalten, selbst wenn der automatische Diagnosebericht Authentifizierungsgeheimnisse ausschließt.

Hat das GitHub-Formular inkompatible Felder, öffnet CodeNomad ein einfaches Issue mit denselben Berichtsinformationen. Ein vorübergehender Lesefehler des Formulars verhindert das Öffnen nicht. Sie können jederzeit manuell die Issue-Liste verwenden.

Community und Releases

Ressource	Verwendung
CodeNomad-Repository	Quelltext, Projektaktivität und Dokumentation.
Issues	Vor reproduzierbarer Fehlermeldung oder Funktionswunsch vorhandene Meldungen durchsuchen.
Pull Requests	Vorgeschlagene Änderungen prüfen oder Beitrag koordinieren.
Neuestes Release	Stabile Download-Artefakte.
Alle Releases	Veröffentlichte Vorschauen und Release-Hinweise.
Neural Nomads	Projektorganisation.
MIT-Lizenz	Lizenzbedingungen.

Bei Problemen mit nativer OpenCode-Konfiguration statt CodeNomad-Steuerung beachten Sie OpenCodes Dokumentation und Upstream-Releases.

Aus Quellcode bauen

Verwenden Sie Node.js 24.20.0 gemäß .node-version, npm, Git und eine kompatible OpenCode-CLI. Führen Sie die Befehle aus einem Entwicklungs-Checkout aus:

git clone --branch dev https://github.com/NeuralNomadsAI/CodeNomad.git
cd CodeNomad
npm ci --workspaces --include=optional
npm run dev

npm run dev startet den Electron-Entwicklungshost. Installieren Sie für Tauri zuerst dessen Plattform-Build-Voraussetzungen einschließlich Rust-Toolchain und führen Sie dann aus:

npm run dev:tauri

Entwicklungsänderungen betreffen den Entwicklungshost, nicht die installierte Version eines unabhängig laufenden OpenCode-Daemons. Native Paketierung benötigt passende Zielwerkzeuge; bevorzugen Sie Builds auf dem Ziel-OS.

Bauen und validieren

Befehl vom Repository-Stamm aus	Zweck
`npm run build`	Electron-Anwendungsressourcen bauen.
`npm run build:tauri`	Tauri-Anwendung mit nativen Voraussetzungen bauen.
`npm run build:ui`	Browseroberfläche bauen.
`npm run build --workspace @neuralnomads/codenomad`	Eigenständigen Server und gebündelte Dateien bauen.
`npm run build:linux --workspace @neuralnomads/codenomad-electron-app`	Electron-Debian-Release paketieren.
`npm exec --workspace @codenomad/tauri-app -- tauri build --bundles appimage`	Linux-Tauri-AppImage paketieren.
`npm run typecheck`	Konfigurierte TypeScript-Workspaces des Stammprojekts prüfen.
`npm run test:help`	Alle öffentlichen Hilfesprachen und Links validieren.
`npm run build:help`	Eigenständige öffentliche Hilfe nach `dist/help` bauen.

Der Hilfe-Build benötigt keinen laufenden CodeNomad- oder OpenCode-Dienst. Paketierungsdetails siehe BUILD.md, gezielte Validierung und PR-Konventionen CONTRIBUTING.md; verwenden Sie tatsächlich im Zielpaket vorhandene Skripte.

Paketübersicht und Beiträge

Paket	Zuständigkeit
`packages/server`	Arbeitsbereichs-/API-/Git-Steuerung, OpenCode-Verbindung, Authentifizierung, Ereignisse und Sprache.
`packages/ui`	SolidJS-Arbeitsbereich, Bedienelemente, Lokalisierung und Browser-Hilfeeinstieg.
`packages/electron-app`	Electron-Fenster, native Integration und Paketierung.
`packages/tauri-app`	Tauri-Fenster, Plattformintegration und Paketierung.
`packages/remote-tunnel`	Backendseitige OpenTunnel-Transportlaufzeit.

Besprechen Sie den Umfang im passenden Issue vor sich überschneidender Implementierung.
Erstellen Sie einen Branch von dev und halten Sie die Änderung fokussiert.
Führen Sie Prüfungen des betroffenen Bereichs aus, aktualisieren Sie die Benutzerhilfe zusammen mit dem Verhalten und richten Sie den PR an dev.

Quellen öffentlicher Hilfe liegen in docs/help/<locale>/. Bewahren Sie explizite ID, Ebene und Reihenfolge jeder englischen Überschrift über Übersetzungen hinweg; übersetzte Überschriften dürfen Deep Links nicht brechen. Der Hilfe-Wartungsvertrag beschreibt strenge Vollständigkeitsprüfungen und die statische Veröffentlichungspipeline.

5.9 KiB Raw Permalink Blame History