Online Documentation
The Docusaurus site is maintained in oo-software/oodi-net-help, under src.
Languages And Structure
English source pages are in src/docs. German and French pages are in src/i18n/<locale>/docusaurus-plugin-content-docs/current, with identical relative file paths. The three site languages, en, de, and fr, are configured in src/docusaurus.config.ts; application UI languages do not automatically create translated manuals.
src/sidebars.ts defines navigation and PDF chapter order. Translate homepage text in src/i18n/<locale>/code.json and category labels in the locale's current.json.
Terminology And Help Links
Use current application labels. A plan stores its configuration, a version is a saved restore point, and a run is one execution. Distinguish a backup destination from the target being overwritten by a restore or clone.
Keep existing page paths and the explicit anchors used by F1 help, even when the visible heading changes. In particular, rescue-media-fortress-mode#fortress-mode remains the application link for the renamed recovery environment.
The help-ID mapping is in the application repository at src/OOSoftware.DiskImage.Shared/Configuration/OEM/SharedGlobals.cs. Check every mapped route and anchor in all built locales.
Documentation Review: 9 October 2026
The review compared the published English and German pages with the application changelog, UI resources, and implementation on B_OODI_ENG_23.0, through commit 2e84cdf47f5547c4d523fc8e8fb2d2ee0b30f0be. The documentation starting point was 881a5f2; the published site still included the removed recovery-partition validation switch.
| Changed area | Documentation |
|---|---|
| Plan setup, automatic defaults, editable sources, one-time full backups | Getting Started; Backup Sources; Backup Plans And Saved Backups |
| History presets, chain-aware retention, permanent keeps | Backup Options; Backup Plans And Saved Backups |
| Local and cloud second copies, retries, restore fallback | Second Copy; Backup Destinations; Restore |
| Monthly schedules, wake-to-run, catch-up, service and tray behavior | Schedules And Automation |
| VHD/VHDX, checkpoints, source locks, conversion and restore restrictions | Backup Options; Tools; Restore Drives |
| Virtual-disk exclusions and locked version settings | Backup Sources; File Names And Exclusions; Settings |
| Recovery rename, restart handoff, startup media, rebuild guidance | Rescue Media And Recovery Environment |
| Reports, fallback reasons, copy warnings, email, diagnostics | Reports And Logs; Common Issues; Settings |
| Utility navigation and Windows Check & Repair | Tools; FAQ |
Unfinished design proposals were not presented as available features. In particular, the automatic offer to make an existing backup drive bootable still has unfinished UI and orchestration work in docs/design/bootable-backup-drive.md in the application repository.
A source update does not publish the site. Deploy the rebuilt site and regenerated manuals through the normal release process, then check the public pages again.
Local Development
From src:
npm ci
npm start
Build all configured languages and check TypeScript with:
npm run build
npm run typecheck
Generate the PDF manuals for all languages with:
npm run build:pdf
Screenshot capture guidance is maintained in SCREENSHOTS.md at the repository root. Add real, current, localized screenshots when available; do not expose capture instructions or missing-image placeholders in the user guide.