Skip to content

docs(authority): keep README.md, GitBook EN/DE and DeepWiki continuously accurate and source-truth aligned #724

Description

@qnbs

Purpose

Establish one long-lived public-documentation authority and parity owner for WorldScript Studio.

This issue owns the continuous reconciliation of:

README.md
        ↕
GitBook — English
https://qnbs.gitbook.io/worldscript-studio/
        ↕
GitBook — Deutsch
https://qnbs.gitbook.io/worldscript-studio/de/
        ↕
DeepWiki repository view
https://deepwiki.com/qnbs/WorldScript-Studio
        ↕
CURRENT REPOSITORY / APP TRUTH

It is intentionally not a one-shot README rewrite issue. The initial comprehensive README/GitBook convergence is only the bootstrap. This issue should remain open as the durable owner for keeping the public documentation accurate while the application evolves.

Do not close it merely because one README/GitBook refresh PR lands. Close only if an equivalent or stronger automated/document-authority mechanism explicitly supersedes it.


Why a dedicated durable owner is needed

WorldScript Studio now has several public documentation surfaces with different roles:

  • README.md — repository/product entry point;
  • GitBook EN — polished reader-facing English documentation;
  • GitBook DE — polished reader-facing German documentation;
  • DeepWiki — code-derived repository exploration/documentation surface;
  • repository docs / ADRs / current source / configuration / CI — engineering and implementation truth.

Without a durable reconciliation owner, these surfaces can independently drift after ordinary feature, security, AI, storage, export, PWA, desktop, native, accessibility, i18n or infrastructure changes.

Recent drift examples already found include:

  • README describing GitHub Pages and Vercel as effectively identical despite materially different host capabilities;
  • overly broad nothing leaves your device / everything works offline style claims;
  • stale AI-mode semantics for Hybrid/Eco;
  • feature-flag count/default drift (15 on / 8 off in current source versus older prose saying 16 / 7);
  • evolving IDB encryption/rekey/recovery behavior;
  • desktop filesystem at-rest-encryption limitations;
  • Claude direct-vs-relay-vs-unavailable host differences;
  • local AI / browser Ollama / local-server capability distinctions;
  • Qt/GPUI roadmap prose that can easily outrun actual authority state;
  • test/i18n metrics that must be source-synchronized rather than hand-maintained.

This issue owns the cross-surface documentation truth, not the underlying implementation work.


1. Documentation authority hierarchy

Use this hierarchy whenever documentation sources disagree:

CURRENT PRODUCTION SOURCE
+ CURRENT TESTS
+ CURRENT CONFIG / CI
+ CURRENT ADR / SECURITY ARCHITECTURE DOCS
        ↓
README.md
        ↓
GitBook EN / DE
        ↓
DeepWiki generated/code-derived presentation
        ↓
ROADMAP / TODO snapshots
        ↓
HISTORICAL sprint/audit/handoff material

Nuance:

  • README and GitBook should be actively curated to match current source truth.
  • DeepWiki is a useful code-derived public view, but generated interpretation must not override current source/ADRs/security authority.
  • ROADMAP/TODO remain important planning sources but must not be treated as stronger implementation evidence than current code and admitted runtime behavior.

Cross-reference #559 for roadmap/native/Core planning-truth reconciliation and #549 for security/privacy truth.


2. Role of each public surface

README.md

README should remain the high-value product/repository entry point:

  • concise but substantial overview;
  • current product philosophy;
  • local-first/offline-capable truth boundaries;
  • primary feature tour;
  • AI execution overview;
  • privacy/security trust boundaries;
  • platform capability summary;
  • current stack;
  • developer quick start;
  • deployment/runtime distinctions;
  • major known limitations;
  • roadmap boundaries;
  • prominent links into deeper documentation.

README should not become a duplicate of every deep GitBook page.

GitBook EN/DE

GitBook owns the reader-oriented deep documentation layer:

  • user workflows;
  • detailed product concepts;
  • privacy/storage/encryption explanation;
  • AI modes/providers;
  • feature maturity;
  • troubleshooting/recovery;
  • architecture/developer pages;
  • platform matrices;
  • security model;
  • English/German documentation parity.

The two language variants should remain semantically aligned while allowing idiomatic localized wording.

DeepWiki

DeepWiki is an intentional additional code-derived repository documentation / exploration surface.

The README must retain the established top-level badge/link:

[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/qnbs/WorldScript-Studio)

This badge is a deliberate long-lived integration and discoverability surface. Do not remove it during README redesigns without an explicit repository-level decision.

At documentation-convergence checkpoints, verify that the DeepWiki repository view remains reachable and reflects a reasonably current indexed repository state. Do not claim that the badge alone is the sole technical refresh mechanism unless that behavior is independently verified against current DeepWiki behavior.


3. Initial README convergence package

The next dedicated README docs PR should start from the already curated comprehensive candidate and requalify it against the then-current main rather than rewriting from scratch.

Required initial improvements include:

  • preserve the DeepWiki badge at the top;
  • prominently link GitBook EN and DE;
  • describe GitBook as reader-facing and repo/current source as implementation authority;
  • add a compact Voice & Dictation product section;
  • add a compact Platform Capability Matrix;
  • add a compact Security Model / trust-boundary hub;
  • preserve ## 📚 Documentation Hub so existing README.md#-documentation-hub references do not break;
  • retain local-first/offline-capable nuance;
  • retain exact host-specific Claude routing truth;
  • retain browser/PWA vs Tauri storage/encryption distinctions;
  • retain explicit feature default-vs-maturity distinction;
  • retain Qt/GPUI as roadmap/gated future work, not current implementation;
  • keep rapidly changing model IDs out of long-lived prose where a canonical runtime catalogue is more appropriate.

The README PR should remain a standalone documentation PR, not be mixed into #719/#708-B/#713/#714 or another source-correctness slice.


4. README metric authority

Do not manually maintain generated metrics when repository automation owns them.

Current repository tooling includes:

pnpm run sync:readme

via scripts/sync-readme-metrics.mjs.

README rewrites must preserve the synchronizer's expected patterns or deliberately update the synchronizer with focused validation.

Metrics such as:

test count
test-file count
i18n key count
locale count

must be derived from current repository state immediately before the README PR is committed.

No hand-frozen count in this issue is authoritative.


5. Continuous documentation triggers

Re-audit README + GitBook whenever a merged change materially affects any existing public claim in these domains:

AI providers / model authority / execution modes
feature flags / defaults / maturity
privacy / security / trust boundaries
storage / encryption / recovery
project identity / async data-integrity semantics
PWA / service worker / offline behavior
deployment / hosting / CSP / proxy behavior
Tauri / desktop capabilities / native storage
Qt / GPUI / Rust Core roadmap authority
collaboration / E2E / room-key semantics
voice / local model downloads / permissions
DuckDB / analytics / OPFS
export formats / compile semantics / backups
plugins / extension model
accessibility
i18n / RTL / locale maturity
CI / validation / contribution workflow
toolchain requirements
release signing / updater / distribution
major user-visible features or removed features

A change does not require rewriting every page. It requires checking whether existing claims became stale.


6. Recommended cadence

Use event-driven reconciliation rather than noisy scheduled churn.

At minimum perform a parity pass:

  1. after a major capability/security/architecture PR changes an existing public claim;
  2. before a tagged/public release when documentation-affecting work has landed;
  3. after canonical AI/provider/model authority changes (ai: requalify current model catalog, defaults and end-to-end AI functionality across all providers #704 lineage);
  4. after feature-coverage/default authority changes (test(feature-flags): establish exhaustive coverage authority and prevent opt-in E2E blind spots #709 lineage);
  5. after platform/runtime strategy changes (docs(roadmap): reconcile root v2 status with native roadmap and Core migration ledger #559/native roadmap lineage);
  6. after security/privacy truth changes (security(truth): consolidate user-visible security/privacy claims across storage, providers, PWA, collaboration & supply chain #549 lineage);
  7. after substantial GitBook restructuring;
  8. when review/audit evidence identifies a stale claim.

Where deterministic drift can be derived from source, prefer automation. Do not try to mechanically generate nuanced privacy/security prose from code.


7. Required parity matrix

Maintain an explicit current disposition for at least:

Topic README GitBook EN GitBook DE Source owner
Product identity / local-first philosophy required required required current source/product architecture
Hosted surfaces / runtime differences summary detailed detailed deployment/config
AI providers/modes summary detailed detailed #704/current registry
Privacy/network boundaries summary detailed detailed #549/security architecture
IDB encryption lifecycle summary detailed detailed storage/security source
Desktop at-rest encryption limitation required warning detailed detailed native/storage source
Collaboration E2E + metadata/revocation summary detailed detailed collab source/issues
Feature flags/defaults/maturity summary detailed detailed #709/feature slice
Voice summary detailed detailed voice source
Export formats/backups summary detailed detailed #715/export source
PWA/Desktop/platform capability matrix detailed matrix detailed matrix deployment/native source
Native roadmap bounded summary developer detail developer detail #559/native roadmap
Developer setup/toolchain required detailed detailed package/CONTRIBUTING
Security model bounded summary detailed detailed #549/threat model
DeepWiki badge + link optional link optional link public integration

Do not force identical text. Require equivalent truth.


8. English/German GitBook parity

For every structural GitBook addition/removal, evaluate both language variants.

Maintain:

same major IA
same technical guarantees
same warnings/non-goals
same platform/provider/security semantics
idiomatic language-specific wording

Do not let DE become a stale translation of EN or vice versa.

If one language intentionally differs, document why.


9. Link and anchor integrity

Before README/GitBook publication:

  • validate repository-relative README links;
  • search for README anchors referenced elsewhere;
  • preserve or migrate README.md#-documentation-hub deliberately;
  • validate GitBook internal references in both variants;
  • verify the EN/DE GitBook URLs;
  • verify GitHub Pages/Vercel/repository/release/security links;
  • verify the DeepWiki badge and repository link.

Do not silently break stable documentation entry points during a visual redesign.


10. Privacy/security absolute-language audit

Whenever README or GitBook is materially rewritten, inspect words such as:

all
always
never
nothing
fully
private
secure
encrypted
offline
local
E2E
zero tracking
no network

Keep an absolute only where the scope is actually proven.

Required enduring distinctions include:

local-first != no network
locally stored != encrypted
API-key encryption != project-data encryption
browser/PWA IDB protection != Tauri filesystem protection
collaboration content encryption != hidden signaling metadata
local AI != every application integration offline
updater signature != OS code signing

#549 remains the specialist security-truth owner; this issue makes sure those truths reach the public documentation surfaces.


11. Feature and AI authority dependencies

#704 AI provider/model authority

After canonical provider/model/default authority changes:

  • re-read current provider registry/catalogue;
  • remove stale exact model names from README/GitBook where they are not durable;
  • ensure mode semantics match runtime;
  • ensure Claude host behavior remains current;
  • ensure local/cloud capability claims match admitted providers.

#709 feature coverage/default authority

After feature-flag/default/maturity changes:

  • derive flag/default counts from current FeatureFlagsState;
  • do not trust stale docs/FEATURE-PARITY.md counts over source;
  • distinguish default ON from production qualification;
  • update GitBook feature-maturity tables and README summary accordingly.

Current known drift to reconcile: source presently represents 23 flags with 15 default-on / 8 default-off, while older docs/FEATURE-PARITY.md prose has described 16 / 7.


12. Relationship to existing owners

This issue is an integration/documentation owner and must not absorb specialist implementation issues.

When one of these changes public truth, reconcile README/GitBook here; do not duplicate the underlying implementation work.


13. Validation for documentation PRs

Re-read package.json at execution time and use only real repository scripts.

Expected relevant checks include, where applicable:

pnpm run sync:readme
pnpm run docs:check
pnpm run content:guard
pnpm run i18n:check
pnpm run lint
pnpm run typecheck
pnpm run ci:prepush

Also validate:

README anchor/link integrity
GitBook EN/DE structure parity
critical privacy/security/AI claims against current source
exact-head CI/review evidence for the README PR
GitBook published content after merge/change-request publication

14. Initial acceptance / bootstrap checklist

The first convergence pass under this issue should achieve:

  • comprehensive README replacement is requalified against current main rather than copied blindly from an older candidate;
  • DeepWiki badge remains at the top of README;
  • GitBook EN and DE are prominently linked;
  • README contains the compact Voice & Dictation section;
  • README contains a compact Platform Capability Matrix;
  • README contains a compact Security Model / trust-boundary section;
  • Documentation Hub anchor compatibility is preserved;
  • generated README metrics are synchronized from current source;
  • current feature defaults/maturity are re-fetched after test(feature-flags): establish exhaustive coverage authority and prevent opt-in E2E blind spots #709-relevant work;
  • AI model/provider/mode authority is re-fetched after ai: requalify current model catalog, defaults and end-to-end AI functionality across all providers #704-A-relevant work;
  • live README no longer claims GitHub Pages/Vercel are operationally identical;
  • live README no longer contains unbounded nothing leaves your device / everything works offline style claims;
  • README and GitBook agree on desktop filesystem encryption limitations;
  • README and GitBook agree on Claude host-specific routing;
  • README and GitBook agree on Local as the strict no-cloud AI inference mode;
  • README and GitBook agree that Eco is also a strict no-cloud AI inference mode (as of the fix(ai): close cloud-AI policy bypass in generateJson/generateImage/streamAiHelpResponse #706/fix(project): guard AI-generation results against a stale/switched active project #707 privacy-gate fix, assertCloudAiAllowed blocks Eco identically to Local — re-verify this against source at execution time rather than trusting this note indefinitely);
  • README and GitBook distinguish feature default state from qualification maturity;
  • README and GitBook describe Qt/GPUI as roadmap/gated work rather than current implementation;
  • DeepWiki link/badge works after the rewrite;
  • GitBook EN/DE remain structurally and semantically aligned;
  • exact-head docs/CI/review gates pass for the README PR;
  • resulting-main README rendering and public documentation links are checked after merge.

15. Long-lived operating contract

After the initial checklist is complete, keep this issue open.

Use comments/checkpoints here to record meaningful documentation-truth events, for example:

MERGED CHANGE / RELEASE
→ affected public claims
→ README disposition
→ GitBook EN disposition
→ GitBook DE disposition
→ DeepWiki/index check if relevant
→ source/evidence links

Avoid comment spam for changes that do not affect documentation truth.

Periodically prune obsolete checkpoint comments only if repository governance supports it; otherwise retain them as a useful public-doc truth history.


Non-goals


Priority / disposition

P2 — long-lived documentation authority / product-truth maintenance.

The initial README convergence should be executed at a clean handoff after the current P1 AI/data-integrity chain has stabilized the implementation truth it needs to describe. Afterwards this issue remains the durable parity owner throughout continued WorldScript Studio development.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions