[Docs] Complete German public documentation and structured metadata localization #20
Closed
opened 2026-08-07 14:50:28 +02:00 by zemion
·
20 comments
No Branch/Tag Specified
Labels
Clear labels
area/api
area/auth
area/db
area/devex
area/docs
area/governance
area/marketing
area/migrations
area/module-system
area/rbac
area/release
area/security
area/tenancy
area/webui
audit/complexity
audit/duplication
audit/false-positive
audit/needs-design
audit/quick-fix
audit/structural
codex/needs-human
codex/ready
module/access
module/addresses
module/admin
module/appointments
module/approvals
module/audit
module/calendar
module/campaign
module/cases
module/committee
module/connectors
module/core
module/dashboard
module/dataflow
module/datasources
module/decisions
module/dist-lists
module/dms
module/docs
module/encryption
module/erp
module/evaluation
module/files
module/fit-connect
module/forms
module/forms-runtime
module/helpdesk
module/identity
module/identity-trust
module/idm
module/ledger
module/mail
module/mandates
module/notifications
module/ops
module/organizations
module/parties
module/payments
module/permits
module/policy
module/poll
module/portal
module/postbox
module/projects
module/quick-access
module/records
module/reporting
module/risk-compliance
module/scheduling
module/search
module/services
module/tasks
module/templates
module/tenancy
module/tickets
module/views
module/voting
module/wiki
module/workflow
module/workflow-engine
module/xoev
module/xrechnung
module/xta-osci
source/backlog-import
source/security-audit
source/todo-scan
HTTP API contracts, routers, schemas, or API smoke behavior.
Authentication, sessions, access bootstrap, or login behavior.
Database sessions, models, transactions, or persistence primitives.
Local developer workflow, scripts, tests, tooling, or release helpers.
Durable documentation and project guidance.
Governance policy, audit, privacy, retention, or compliance behavior.
Public website, product messaging, publication copy, or legal page content.
Alembic migrations, schema bootstrap, or persistence evolution.
Module discovery, manifests, capabilities, routing, or optional integrations.
Permissions, roles, delegation, or authorization policy.
Versioning, release locks, tags, packaging, or dependency pins.
Security posture, static analysis, supply-chain hardening, or vulnerability remediation.
Tenant boundaries, provisioning, or tenant-scoped data behavior.
Shared WebUI shell, frontend components, routing, or frontend tests.
Complexity finding from Radon, Xenon, or equivalent maintainability scans.
Duplicated-code finding from jscpd or equivalent similarity scans.
Audit finding reviewed as a narrow false positive or acceptable risk.
Audit finding that needs an architectural or product decision before implementation.
Audit finding that appears narrow and directly fixable.
Audit finding that needs design, refactoring, or behavior review.
Needs an explicit human decision before Codex should implement.
Suitable for Codex to pick up with the existing issue context.
GovOPlaN access, identity, authentication, RBAC, and administration behavior.
GovOPlaN Addresses module behavior or integration.
GovOPlaN Admin module behavior or integration.
GovOPlaN Appointments module behavior or integration.
GovOPlaN Approvals module behavior or integration.
GovOPlaN Audit module behavior or integration.
GovOPlaN Calendar module behavior or integration.
GovOPlaN campaign module behavior or integration.
GovOPlaN Cases module behavior or integration.
GovOPlaN Committee module behavior or integration.
GovOPlaN Connectors module behavior or integration.
GovOPlaN core runner, shared primitives, shell, or extension points.
GovOPlaN Dashboard module behavior or integration.
GovOPlaN Dataflow module behavior or integration.
GovOPlaN governed datasource contracts, catalogs, and integrations.
GovOPlaN formal Decisions module behavior or integration.
GovOPlaN Distribution Lists module behavior or integration.
GovOPlaN Dms module behavior or integration.
GovOPlaN Docs module behavior or integration.
GovOPlaN Encryption key custody, cryptographic policy, and E2EE integration.
GovOPlaN Erp module behavior or integration.
GovOPlaN Evaluation module behavior or integration.
GovOPlaN files module behavior or integration.
GovOPlaN Fit Connect module behavior or integration.
GovOPlaN Forms module behavior or integration.
GovOPlaN Forms Runtime module behavior or integration.
GovOPlaN Helpdesk module behavior or integration.
GovOPlaN Identity module behavior or integration.
GovOPlaN Identity Trust module behavior or integration.
GovOPlaN Idm module behavior or integration.
GovOPlaN Ledger module behavior or integration.
GovOPlaN mail module behavior or integration.
GovOPlaN Mandates, jurisdiction, responsibility, and authority behavior or integration.
GovOPlaN Notifications module behavior or integration.
GovOPlaN Ops module behavior or integration.
GovOPlaN Organizations module behavior or integration.
GovOPlaN procedure Parties, representation, and delivery-authority behavior or integration.
GovOPlaN Payments module behavior or integration.
GovOPlaN Permits module behavior or integration.
GovOPlaN Policy module behavior or integration.
GovOPlaN Poll module behavior or integration.
GovOPlaN Portal module behavior or integration.
GovOPlaN Postbox module behavior or integration.
GovOPlaN Projects module behavior or integration.
GovOPlaN configurable task-local Quick Access behavior and integrations.
GovOPlaN Records and eAkte lifecycle behavior or integration.
GovOPlaN Reporting module behavior or integration.
GovOPlaN Risk Compliance module behavior or integration.
GovOPlaN Scheduling module behavior or integration.
GovOPlaN Search module behavior or integration.
GovOPlaN versioned institutional Services behavior or integration.
GovOPlaN Tasks module behavior or integration.
GovOPlaN Templates module behavior or integration.
GovOPlaN Tenancy module behavior or integration.
GovOPlaN Tickets module behavior or integration.
GovOPlaN governed task views, interface projections, and workflow view integration.
GovOPlaN Voting module behavior or integration.
GovOPlaN Wiki module behavior or integration.
GovOPlaN Workflow module behavior or integration.
GovOPlaN Workflow Engine runtime, persistence, or integration.
GovOPlaN Xoev module behavior or integration.
GovOPlaN Xrechnung module behavior or integration.
GovOPlaN Xta Osci module behavior or integration.
priority
p0
Immediate stop-the-line priority.
priority
p1
High priority for the next focused work window.
priority
p2
Normal planned priority.
priority
p3
Low priority or opportunistic cleanup.
Imported from markdown backlog, roadmap, plan, or TODO files.
Created from a structured security or code-quality audit report.
Imported from inline TODO/FIXME/HACK markers by the Gitea TODO importer.
status
blocked
Cannot progress without a decision, dependency, credential, or external change.
status
in-progress
Currently being worked.
status
needs-info
Needs clarifying input before implementation can proceed safely.
status
ready
Ready for implementation.
status
triage
Needs review, ownership, priority, or acceptance criteria.
type
bug
A reproducible defect, regression, or incorrect behavior.
type
debt
Cleanup, refactoring, risk reduction, or deferred engineering work.
type
docs
Documentation, process, or developer workflow work.
type
feature
New user-visible behavior or platform capability.
type
task
Implementation, maintenance, migration, or operational work.
type
user-story
End-to-end user journey or real-world process story used to steer product slices.
Milestone
No items
No Milestone
Projects
Clear projects
No projects
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: GovOPlaN/govoplan-docs#20
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Context
The manifest-driven public documentation exporter and the public
/docssurface now use the same staticDocumentationTopicsources as the installed Help Center. The generated catalog now contains 68 modules and 313 static topics; 143 topics have complete German title, summary, and body content. Structured German localization is versioned and currently complete for 16 of 183 localizable topics.The generated gap report is committed at
addideas-govoplan-website/docs/DOCUMENTATION_COVERAGE.md.Required Work
Acceptance Criteria
Related: govoplan-docs#16 and add-ideas/addideas-govoplan-website#1.
Starting a bounded reference-locale batch: complete every static Mail topic in German and add exact high-risk contextual-help coverage for the new POP3 legacy-import workflow. This advances the all-module coverage target without requiring product-policy choices.
Progress slice released in Mail v0.1.21.
Evidence:
This is a complete Mail-owned localization batch; the cross-module Docs umbrella remains open for the remaining module gaps.
Starting the next autonomous Docs-owned batch: complete German title, summary, and body coverage for the six remaining Docs topics, add a manifest-wide regression contract, verify the public export reports no Docs module gap, and release/synchronize the catalog. This requires no product-policy decision.
Released Docs v0.1.20 as the next German-reference coverage batch.
Evidence:
d6560b343aVerification:
This removes the Docs-owned localization gap. The umbrella remains open for German/reference gaps still owned by other modules.
Starting the next bounded cross-module batch: REST and SOAP are the two remaining modules whose public-catalog gap is localization-only (one reference topic each). I am adding complete German title/summary/body coverage plus owner-level regression tests, releasing both modules, and validating them together through the workspace gate. No product or policy decision is involved.
Released the REST/SOAP localization-only batch.
REST:
SOAP:
Workspace catalog:
Results:
The umbrella remains open for the remaining owner-module batches.
Starting the next autonomous documentation-contract batch:
Both changes describe already-implemented behavior and require no policy choice. I will release them together through one full workspace gate.
Released the Tasks/Postbox documentation-contract batch.
Tasks v0.1.20:
Postbox v0.1.19:
Workspace:
The umbrella remains open for subsequent owner batches.
Starting the next autonomous public-documentation coverage batch for Portal, Views, and Quick Access. Scope: promote their already implemented service-directory, View-selection, and Quick Access rail flows to explicitly scope-conditioned workflow topics; classify Quick Access privacy/DSAR consequences as its field/effect reference; complete all six remaining German topic baselines; add owner-level coverage regressions; release all three modules; and update/verify the workspace catalog. No product-policy decision or behavior change is involved.
Completed and released the Portal / Views / Quick Access public-documentation coverage batch.\n\nReleased:\n- Portal v0.1.19:
91f5a332a8905461ef0391d3741529f35eda8afc(annotated tag object9a5ddf201fb7ef743dfae1fa3ae6e941b2e45607)\n- Views v0.1.19:acd0d3bdaeabf436f015b265e437207a155615ec(annotated tag object465a854caaa3e30b5287ba63dceb457194d27e96)\n- Quick Access v0.1.19:ac2f47bd7a5ce73080fd80a9c26a1f037ff85d34(annotated tag objectaf7f1713599b819df463cae9a35453c946e4c9df)\n- Workspace catalog pins:e07b3487e300446b68153a03ae146d4882140bb1\n\nCoverage result: all six remaining German topic baselines completed; existing service-directory, View-selection, and Quick Access rail flows are now explicit scope-conditioned workflows; Quick Access DSAR field/effect consequences are an explicit reference. Portal, Views, and Quick Access each report zero public-catalog gaps. Aggregate coverage is now 77/298 fully German topics and 59 gap-bearing modules (from 71/298 and 62).\n\nVerification: owner suites Portal 11/11, Views 45/45, Quick Access 15/15; owner frontend structural checks; 68/68 manifest/architecture validation; fulltools/checks/check-focused.sh, including 59 WebUI permutations, full-product bundle budgets, 8/8 Playwright conformance tests, and downstream component/type/structure checks. Remote main commits, annotated tag objects, and peeled tag targets were verified through the Gitea API.Starting a decision-free seed-boundary documentation batch across 17 one-topic modules: Assets, Booking, Certificates, Consultation, Contracts, Evaluation, Facilities, Grants, Helpdesk, Inspections, Learning, Permits, Procurement, Resources, Tickets, Transparency, and Wiki. Each repository is currently a deliberately non-invasive seed with no frontend/runtime workflow. Its single topic already enumerates owned domain fields and the consequence that no runtime API, persistence, migration, or WebUI exists yet. I will make that reference semantics explicit, add a complete German baseline, add owner regression assertions, release v0.1.19 per module, and update the workspace pins. This changes no product behavior or policy.
Completed the autonomous seed-boundary public-documentation batch.
Released
v0.1.19for Assets (27cfe2e), Booking (1400a9f), Certificates (b50c15e), Consultation (aff4df9), Contracts (e75ec88), Evaluation (4d44357), Facilities (13131f8), Grants (4ca6535), Helpdesk (064ec61), Inspections (51935b1), Learning (a8f6e97), Permits (1ad0582), Procurement (0e35520), Resources (5ced341), Tickets (b4bb52d), Transparency (8f6cb0a), and Wiki (572cb91). Workspace pin integration: GovOPlaN/govoplancd498dc.Each deliberately non-invasive seed now supplies a complete German static topic, declares the topic as a
reference, records the unavailable-runtimeseed_boundaryconsequence, and has an owner regression for these guarantees. The public projection moved from 77/298 to 94/298 German-complete topics and from 59 to 42 modules with coverage gaps.Validation passed: all 17 owner suites; manifest shape/architecture checks for 68/68 modules; public catalog projection; full
tools/checks/check-focused.sh, including backend and migration matrices, 59 WebUI module permutations, full-product bundle budget, 8/8 Playwright conformance scenarios, and downstream type/structure checks. Remote main commits, annotated tag objects, and peeled tag targets were verified through the Gitea API.This does not claim runtime feature completion: Tickets #1 and Wiki #1 correctly remain open. The documentation umbrella remains open for the remaining 42 gap modules.
Completed the next decision-free, localization-only documentation batch.
Released Ops
v0.1.19(f4f0931), Pollv0.1.19(bf25e88), Auditv0.1.19(f71434e), and Workflowv0.1.21(fa0bdde). Workspace release requirements and developer meta-package pins are integrated in GovOPlaN/govoplan79c4cb0.All 12 existing topics now have complete German title, summary, and body translations. Their already-correct workflow/reference/system classifications and behavior boundaries were preserved. Workflow package surfaces were aligned by correcting its stale
__version__to0.1.21; no runtime semantics changed.The public projection moved from 94/298 to 106/298 German-complete topics and from 42 to 38 modules with coverage gaps. Owner suites passed (Ops 7, Poll 73 with one skip, Audit 19, Workflow 53), as did the 68/68 manifest/architecture checks and full
tools/checks/check-focused.sh: backend and migration matrices, shared UI contracts, 59 WebUI permutations, full-product bundle budget, 8/8 Playwright conformance scenarios, and downstream type/structure checks.Remote main commits, annotated tag objects, and peeled tag targets were verified through the Gitea API. Ops #2 and Workflow #14 remain open because this slice does not implement deployment controls or remove the compatibility facade. The documentation umbrella remains open for the remaining 38 gap modules.
Implemented and released the versioned structured-documentation localization foundation and the first owner migrations.
Delivered:
DocumentationTopicnow supports structured translation contract v1 with exact-shape, key, version, string, and non-text-leaf validation.12fe709): runtime locale overlay, localized safe projection, structured coverage reporting, and a monotonic baseline check integrated into--check.Coverage moved from 123 to 131 complete German topics out of 313 and from 38 to 34 gap modules. Structured German coverage starts at 4 complete topics out of 177 localizable topics. The baseline now fails on regressions in complete German topics, structured-contract adoption, structured completeness, missing topics, and gap modules.
Verification: targeted owner/Core/Docs suites passed;
npm run docs:generate,npm run docs:check, and the website production build passed; the full 68-module focused gate passed, including 63 WebUI permutations and 8/8 browser conformance tests.Keeping this umbrella open: 182 static German topic gaps, 173 structured-metadata gaps, and the remaining per-module workflow/reference/administrator coverage still need migration.
Second autonomous owner-migration batch released:
reporting:definition:read-conditioned governed-BI workflow with prerequisites, steps, limitations, operational consequences, and verification; a structured DSAR consequence reference; owner regression tests.search:result:read-conditioned global/contextual-search workflow with ACL-safe steps, limitations, index-operation consequences, and verification; a structured DSAR consequence reference; owner regression tests.Both modules now have no public-documentation coverage gaps. Aggregate coverage moved from 131 to 135 complete German topics out of 313, structured German coverage from 4/177 to 8/181, and gap modules from 34 to 32. The reviewed monotonic baseline was advanced to those values.
Verification passed: Reporting 22/22 backend tests; Search 22 backend tests with the optional PostgreSQL environment test skipped; owner Ruff/format and WebUI contracts; all 68 manifest checks; deterministic docs check and website production build; complete focused gate including 63 WebUI permutations, full-product bundle budgets, and 8/8 Playwright conformance tests.
Keeping the umbrella open for the remaining 178 German title/body gaps, 173 pre-existing structured-metadata gaps, and remaining module workflow/reference/administrator migrations.
Shipped the next owner-documentation batch:
Coverage moved from 135/313 to 143/313 complete German topics. Structured German coverage moved from 8/181 to 16/183; missing structured translations fell to 167, and gap modules fell from 32 to 28. The generated catalog and non-regression baseline are published in add-ideas/addideas-govoplan-website@9d42c01.
Verification: all four owner suites and lint checks, manifest registry (68/68), deterministic docs check and website build, full focused workspace gate, 63 WebUI permutations, bundle budgets, and 8 Playwright conformance tests passed. This issue remains open for the remaining 170 German topic translations and 28 module-level gaps.
German reference-debt wave published (2026-08-23).\n\nCoverage moved from the last published baseline to:\n- German-complete static topics: 143 -> 182 of 322\n- Missing German static topics: 170 -> 140\n- Modules with documented coverage gaps: 28 -> 20\n- Structured German workflow/reference contracts: 16 -> 39 of 189\n- Catalogued modules/topics: 68/313 -> 72/322\n\nPublished owner releases:\n- v0.1.19: approvals, dashboard, dist-lists, notifications, committee, encryption, forms-runtime, organizations\n- v0.1.20: dms, erp, fit-connect\n- v0.1.21: records, xrechnung\n\nThe translations cover permission-scoped workflows, settings, field semantics, limitations, operational consequences, and verification metadata. DMS, ERP, FIT-Connect, XRechnung, and Records no longer have public documentation gaps. The encryption text documents the implemented server-envelope/E2EE boundary without choosing a tenant policy.\n\nComposition/catalog commits:\n- GovOPlaN/govoplan@c50f699\n- add-ideas/addideas-govoplan-website@7b3ca3c\n\nVerification:\n- all affected owner test suites and Ruff checks passed\n- 72/72 manifest and architecture checks passed\n- website documentation check and production build passed\n- full focused workspace gate passed, including 63 WebUI permutations, full-product bundle budget, 8 Playwright conformance tests, and downstream UI structure tests\n\nRemaining gap modules: access, addresses, admin, calendar, campaigns, cases, connectors, dashboard, dataflow, datasources, files, forms, identity, idm, policy, scheduling, templates, tenancy, voting, workflow_engine.\n\nThe dashboard gap is intentionally still reported: German content and structured reference metadata are complete, but there is no route-specific permission contract from which to claim a scope-conditioned user workflow. This umbrella should remain open for the remaining public German and exact/contextual-help debt.
German reference localization burn-down — final progress (2026-08-23)
This supersedes the intermediate coverage figures posted earlier in this issue.
Remaining bounded debt
campaigns: 31 untranslated topics.files: 15 untranslated topics.connectors: 7 untranslated topics plus a user workflow and field/consequence reference.dataflow: 5 untranslated topics plus a user workflow and field/consequence reference.dashboard: fully German and structured, but still lacks a permission-conditioned user workflow. This is intentionally not fabricated: the current product contract has no route-specific Dashboard read scope, so resolving it requires either an explicit read permission or a decision that every authenticated user is in scope.Releases published
v0.1.21, Adminv0.1.20, Policyv0.1.21, Schedulingv0.1.20, Addressesv0.1.19, Calendarv0.1.20, Casesv0.1.21, Datasourcesv0.1.22, IDMv0.1.22, Formsv0.1.21, Identityv0.1.19, Templatesv0.1.19, Tenancyv0.1.19, Votingv0.1.19, and Workflow Enginev0.1.20.Verification and publication
fe83290d56a5862eabc84599d86795d2a49b3b1f.34bcbdda3348935f53a06f41b7ef7c50a6ed3db4.The umbrella remains open for the five explicitly listed modules and the separate structured-metadata migration. A native-speaker editorial review remains advisable, but no manual verification is required for release correctness.
German reference localization burn-down — completed static coverage (2026-08-23)
This supersedes both earlier progress comments from today; the translation-only residual wave has now also shipped.
Sole remaining module-level gap
dashboard: all 3 topics are German-complete and its two structured topics are complete. The remaining user-workflow flag requires a permission-model decision: either introduce an explicit Dashboard read scope or declare the Dashboard universally available to authenticated users. No scope was invented in documentation.Final residual releases
v0.1.23(d86894b): 7 translations, permission-conditioned workflow, field/consequence reference, structured German contract.v0.1.21(08c1ecb): 5 translations, permission-conditioned workflow, explicit reference archetypes, structured German contract.v0.1.21(74c2609): 15 translations.v0.1.25(b41f23c): 31 translations and corrected package-version alignment.These follow the 28 module releases listed in the preceding comment, for 32 module releases in the complete localization wave.
Verification and publication
a886a9b3def386fc9f533ea78028d4f58fcef302.040ff06961b4a843a24192259ec1f288766fe1b7.No manual verification is required for release correctness. A native-speaker editorial pass remains advisable. The umbrella should remain open only for the Dashboard scope decision and the separate 150-topic structured-metadata migration.
Completed and published the final acceptance slice.
v0.1.20(ec240ed) introduces the grantabledashboard:dashboard:readscope, adashboard_userrole template, backend 403 enforcement, and matching frontend route/navigation guards. Its configurable-home documentation is now a scope-conditioned workflow.v0.1.38(d2e4913) adds validated owner-localized structured-translation merging; all remaining structured German metadata was added in 45 owning-module releases without changing stable IDs, API paths, field IDs, keys, or permission scopes.3f75ca8; website/catalog2ecb31d.Verification passed: all 72 manifest/architecture contracts, owner suites, strict platform inventory, deterministic docs check, 63 optional-module WebUI permutations, the full-product bundle and budgets, and 8/8 Playwright conformance journeys. Remote
mainand the peeled release-tag target were verified for all 47 release repositories.All acceptance criteria of this umbrella are now met, so it is being closed. Exact high-risk field/action F1 content remains separately tracked by Core #284.