You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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;
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);
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:
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;
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;
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.
Purpose
Establish one long-lived public-documentation authority and parity owner for WorldScript Studio.
This issue owns the continuous reconciliation of:
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;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:
nothing leaves your device/everything works offlinestyle claims;15 on / 8 offin current source versus older prose saying16 / 7);This issue owns the cross-surface documentation truth, not the underlying implementation work.
1. Documentation authority hierarchy
Use this hierarchy whenever documentation sources disagree:
Nuance:
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:
README should not become a duplicate of every deep GitBook page.
GitBook EN/DE
GitBook owns the reader-oriented deep documentation layer:
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:
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
mainrather than rewriting from scratch.Required initial improvements include:
## 📚 Documentation Hubso existingREADME.md#-documentation-hubreferences do not break;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:
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:
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:
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:
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:
Do not force identical text. Require equivalent truth.
8. English/German GitBook parity
For every structural GitBook addition/removal, evaluate both language variants.
Maintain:
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:
README.md#-documentation-hubdeliberately;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:
Keep an absolute only where the scope is actually proven.
Required enduring distinctions include:
#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:
#709 feature coverage/default authority
After feature-flag/default/maturity changes:
FeatureFlagsState;docs/FEATURE-PARITY.mdcounts over source;Current known drift to reconcile: source presently represents 23 flags with 15 default-on / 8 default-off, while older
docs/FEATURE-PARITY.mdprose 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.jsonat execution time and use only real repository scripts.Expected relevant checks include, where applicable:
Also validate:
14. Initial acceptance / bootstrap checklist
The first convergence pass under this issue should achieve:
mainrather than copied blindly from an older candidate;Documentation Hubanchor compatibility is preserved;nothing leaves your device/everything works offlinestyle claims;assertCloudAiAllowedblocks Eco identically to Local — re-verify this against source at execution time rather than trusting this note indefinitely);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:
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.