Skip to content

Docs: adopt WVO Technical English - #38

Merged
Artsen merged 1 commit into
mainfrom
docs/wvo-technical-english
Jul 25, 2026
Merged

Docs: adopt WVO Technical English#38
Artsen merged 1 commit into
mainfrom
docs/wvo-technical-english

Conversation

@Artsen

@Artsen Artsen commented Jul 25, 2026

Copy link
Copy Markdown
Owner

Summary

Adds WVO Technical English as the project-specific documentation writing standard and applies the first documentation pass across the setup, user, configuration, troubleshooting, support, API, architecture, testing, privacy, security, contributing, README, and brand documentation surfaces.

Base

Base main commit: d7c7ce18845691d89a1b951444827caaa24a1007

ASD-STE100 Influence

  • WVO Technical English is informed by ASD-STE100 Simplified Technical English principles.
  • This project does not claim formal ASD-STE100 compliance.
  • No ASD-STE100 controlled dictionary content is copied into the repository.

Documentation Changed

  • Added docs/writing-style.md with WVO-specific terminology, writing rules, procedure structure, error format, and review checklist.
  • Updated docs/README.md, README.md, CONTRIBUTING.md, and docs/brand-system.md to point contributors at the new documentation standard.
  • Reworked Level 1 docs for clearer procedures and recovery language: docs/getting-started.md, docs/user-guide.md, docs/configuration.md, docs/troubleshooting.md, and SUPPORT.md.
  • Applied Level 2 terminology updates in docs/api.md, docs/architecture.md, docs/testing.md, SECURITY.md, and PRIVACY.md.

Follow-ups

Runtime copy was audited but not changed in this documentation-only PR. Follow-up runtime/template work should address:

  • apps/api/src/services/package-service.ts: generated package README.txt and preview copy still use generated runtime wording such as Web Video Package, Caption note, generate subtitles in the app, and subtitle-track explanatory text.
  • apps/web/src/domain/job-presenters.ts: user-facing package copy says ZIP bundle for website handoff.
  • apps/web/src/features/outputs/PackagePanel.tsx and apps/web/src/features/outputs/OutputsView.tsx: package sidebar copy says handoff bundle.
  • apps/web/src/features/prepare/SourceDetails.tsx: user-facing caption readiness copy uses embedded subtitles where docs now prefer embedded subtitle track.
  • apps/web/src/features/poster/PosterLightbox.tsx: poster aria label uses poster preview image; review whether poster alone is clearer.

Validation

  • npm ci passed.
  • npm run format passed.
  • npm run format:check passed: all matched files use Prettier code style.
  • npm run lint passed with --max-warnings=0.
  • npm run typecheck passed.
  • npm run test:run passed.
    • Scripts: 7 tests passed.
    • Contracts: 26 tests passed.
    • Video core: 39 tests passed.
    • API: 230 tests passed, 1 skipped.
    • Web: 86 tests passed.
  • npm run build passed.
  • npm run check passed.
  • git diff --check passed.
  • Markdown local links and image targets resolve.

Scope Confirmation

  • Documentation-only change.
  • No application behavior changes.
  • No runtime code changes.
  • No dependency changes.
  • No test changes.
  • No screenshots or generated media changes.
  • No private files, local data, .tmp, data, or generated artifacts included.

@Artsen
Artsen merged commit 600582c into main Jul 25, 2026
4 checks passed
@Artsen
Artsen deleted the docs/wvo-technical-english branch July 25, 2026 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant