Docs: adopt WVO Technical English - #38
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
d7c7ce18845691d89a1b951444827caaa24a1007ASD-STE100 Influence
Documentation Changed
docs/writing-style.mdwith WVO-specific terminology, writing rules, procedure structure, error format, and review checklist.docs/README.md,README.md,CONTRIBUTING.md, anddocs/brand-system.mdto point contributors at the new documentation standard.docs/getting-started.md,docs/user-guide.md,docs/configuration.md,docs/troubleshooting.md, andSUPPORT.md.docs/api.md,docs/architecture.md,docs/testing.md,SECURITY.md, andPRIVACY.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 packageREADME.txtand preview copy still use generated runtime wording such asWeb 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 saysZIP bundle for website handoff.apps/web/src/features/outputs/PackagePanel.tsxandapps/web/src/features/outputs/OutputsView.tsx: package sidebar copy sayshandoff bundle.apps/web/src/features/prepare/SourceDetails.tsx: user-facing caption readiness copy usesembedded subtitleswhere docs now preferembedded subtitle track.apps/web/src/features/poster/PosterLightbox.tsx: poster aria label usesposter preview image; review whetherposteralone is clearer.Validation
npm cipassed.npm run formatpassed.npm run format:checkpassed: all matched files use Prettier code style.npm run lintpassed with--max-warnings=0.npm run typecheckpassed.npm run test:runpassed.npm run buildpassed.npm run checkpassed.git diff --checkpassed.Scope Confirmation
.tmp,data, or generated artifacts included.