Workflow

Mit dem Server

$ deciwa serve                 # build, serve, watch – http://127.0.0.1:4337

  1. Bauen – deciwa serve baut die Docs einmal und beobachtet dann die Quellen und die Erweiterung; jede Änderung löst einen inkrementellen Build aus, und offene Seiten laden sich selbst neu und behalten ihre Scrollposition.

  2. Reviewen – öffne eine Seite, schalte Review ein (Shift+R) und gib Feedback. Alles wird sofort nach .deciwa/annotations/ geschrieben.

  3. Arbeiten – die KI oder jemand aus der Entwicklung nimmt die offenen Aufgaben:

    $ deciwa todo                          # what to do: comments, rejects, deletes, questions
$ deciwa resolve <id> --note "…"      # done

    Sag Claude „arbeite das deciwa-Feedback ab“ – siehe Claude.

  4. Prüfen – die geänderten Quellen werden neu gebaut; ein freigegebener Text, der sich geändert hat, ist jetzt stale und zeigt die alte und die neue Formulierung. Gib ihn erneut frei oder gib neues Feedback.

  5. Committen – .deciwa/ kommt zusammen mit den Docs in Git.

deciwa status zeigt die Abdeckung des ganzen Projekts im Terminal; der Reiter Project im Panel zeigt dasselbe im Browser.

Offline

Ohne deciwa serve funktioniert das Overlay allein: ein einfacher statischer Build, ein Laptop ohne CLI oder eine Demo auf einer Website.

$ sphinx-build -b html -D deciwa_mode=offline -D deciwa_offline_annotations=0 \
    docs docs/_build/offline

  • Öffne index.html direkt aus dem Ordner (file://), gib den Ordner als ZIP weiter oder veröffentliche ihn als statische Dateien – kein Server nötig.

  • Der deciwa-Button zeigt offline; Feedback bleibt in diesem Browser und übersteht Neuladen und Seitenwechsel.

  • Der Panel-Reiter Im/Export lädt alles als eine deciwa-Datei herunter, lädt eine in den Browser oder setzt auf das zurück, was der Build mitgebracht hat.

  • Einen Export ins Repository bringen:

    $ deciwa import deciwa-review-20261019T2021.json

Import und Export

Eine deciwa-Datei enthält die Review-Daten des ganzen Projekts plus zwei Zeitpunkte: wann sie exportiert wurde und wann sich die Daten zuletzt geändert haben.

  • Kein Zusammenführen – ein Import ersetzt alle Review-Daten.

  • Nie älter über neuer – der Server und deciwa import lehnen eine Datei ab, deren letzte Änderung älter ist als die des Projekts; deciwa import --force übergeht das. Der Browser warnt stattdessen.

  • deciwa export [file] schreibt dieselbe Datei von der Kommandozeile.

Der Reiter Im/Export im Panel

Der Panel-Reiter Im/Export.

Einen Review-Build veröffentlichen

Für eine öffentliche Demo setz deciwa_mode=offline und deciwa_offline_annotations=0: nichts wird irgendwohin geschickt, und Besucher starten mit einem leeren Review in ihrem eigenen Browser.