Documentation deep dive - findings and open points
Date: 2026-06-12 Status: complete. All 255 documentation pages (de + en), the changelogs, sidebars, README and the start/demo/partner pages were reviewed in two passes. Safe fixes were applied directly (106 files changed, uncommitted); everything that needs a human decision is listed in section 2.
1. What was fixed automatically (106 files, uncommitted)
All changes are in the working tree, nothing committed. Review with git diff.
Real bugs
de/docs/features/index.md: page was titled "Rollout via MDM" in title, description and H1 (copy-paste error). Now "2. Features" like the en version.en/docs/features/mdm/mdm_intune/index.md: the JSON example contained curly typographic quotes insidecustomScriptCodeand thecKeyboardlayout string. Copying it into Intune would have produced a broken config. Replaced with straight quotes (de already had them).de+en/docs/start/requirements/index.md: broken link/docs/faq/webview-white-screen(page does not exist) fixed to/docs/faq/white-screen/.de+en/docs/features/mdm/mdm_soti/index.md: image referenced asSchritt6_soti.pngbut the file is lowercaseschritt6_soti.png; 404 on case-sensitive servers. Fixed..vitepress/sidebars/de.json+en.json: knowhow "Index" entry linked to/docs/knowhow/index/, which does not exist in the build. Fixed to/docs/knowhow/.en/docs/knowhow/auth/certificates_azure+certificates_sap: duplicatesidebar_position: 4(three pages shared it). Deduplicated to mirror de.en/docs/knowhow/browser/reasons-for-industry-browser: a link pointed to the German URL (/de/docs/...) from the English page. Fixed.de+en/docs/features/logging/logging: said "two options" but lists three; also had duplicate H1 headings. Fixed in both languages.de/docs/features/keyboard/custom_keyboards+ en counterpart: unclosed ```html code fence at end of file.- README.md: broken bold/code markup in the "Achtung" paragraph rebuilt; raw
<Translate>tags wrapped in backticks so they render; many spelling errors ("Datien", "wlechem", "zB.").
Mistranslations corrected (en text said something different than de)
en/docs/features/tools/demo: "commissioning" -> "picking" (Kommissionierung).en/docs/features/userinterface/connection_lost: feature description inverted the meaning (said it prevents data from being saved; actually warns that scans cannot be saved/sent).en/docs/features/backhandscanner/nimmsta+proglove: pairing sentence said "a QR code opens for the first time" instead of "the first time such a page is opened, a QR code appears".en/docs/features/cert_login/device_certificate: "Personal devices" -> "Personally assigned devices" (was readable as BYOD).en/docs/features/automation/nfc_login: "register regularly" -> "log in regularly".
de/en parity (drift repaired by translating the existing counterpart)
- de hardware: NIMMSTA/ProGlove info box; de javascript_api: Launchpad intro; en javascript_api: currentLaunchpadData note; de knowhow mdm: 5th decision point "Kosten"; de knowhow certificates: summary paragraph; de knowhow nfc: RFID industry paragraph (plus garbled UHF range sentence repaired); en proglove: multi-range model note; de scripts: closing sentence; de knowhow btp: SAP BTP SDK passage; en fast_track: missing "Installation manually or via MDM" heading; en start/overview: completed the SAP integration sentence.
Localization of German pages that carried English text
- German section index pages (features, tools, userinterface, startpages, knowhow browser, knowhow sap): English boilerplate descriptions and link labels translated.
de/docs/features/keyboard/custom_keyboards: frontmatter description and all 18 keywords were untranslated English; now German.- German alt texts that were English copy-paste leftovers (fast_track, updates) corrected.
Naming, spelling, grammar, formatting (both languages, ~60 files)
- Product naming unified: DataWedge, NIMMSTA, ProGlove, TensorFlow, jQuery, Play Store, "Launcher-Profil", Smartcard, "Screenshot-Sperre".
- "a SAP" -> "an SAP", "licence" -> "license" (site uses American spelling), German comma and orthography fixes throughout, German quote style unified, smart apostrophes replaced with ASCII, heading hierarchy fixes (stray H1s demoted), table header capitalization, duplicate frontmatter keywords removed, broken blockquote image syntax fixed.
2. Needs your input / decision
High priority
- README.md is outdated (describes Docusaurus, project is VitePress). The "Anleitung für lokale Entwicklung" and "Übersetzungen" sections describe
npm run start/start-de, ani18n/folder and the Docusaurus<Translate>workflow. Actual scripts aredev/build/previewand translation happens via the mirroredde//en/trees plus React components. Needs a rewrite by someone who knows the intended workflow. Also: the README publishes the full partner access-hash URLs and itself notes the scheme only obscures access; confirm the repo is private enough for that. - Intune reference contradictions (
de+en/docs/features/mdm/mdm_intune): the settings table says log level "WARN" but the JSON-keys table says "WARNING"; the example JSON setsZoomAmountasvalueInteger: 100but the reference table declares type string. Same in both languages, so it needs verification against the app/MDM schema. - UI label verification needed (text contradicts itself, only the app can settle it):
- en
security/ssl_untrust: setting called "Allow insecure connections" in one place, "Unsecured connections" in the path and screenshot. - de
security/screenshot_disabled: page says the toggle is called "Bildschirmsperre" (screen lock), but the feature is screenshot blocking. - en
userinterface/progress_indicator: titled "Loading indicator", path says "Progress indicator". - de/en logging: "Erweiterter Debug-Modus" vs "Extended Logging Mode".
- de/en
userinterface/toolbar: single-tap-to-hide / double-tap-to-show gesture claim looks suspicious; verify in the app.
- en
- Invalid CSS in
de+en/docs/faq/rfui_custom_scripts: the selector list contains a double comma (> span, , #userpanel), which silently drops the whole rule in browsers. Left untouched (code sample); fix if the upstream script does not contain it.
Decisions on structure and policy
- sidebar_position drift between de and en trees (many pages, e.g. keyboard/keyboard de=23 vs en=1, screenshot_disabled de=21 vs en=7, page_zoom de=22 vs en=2, plus a dozen more; knowhow/sap pages all share position 2). If frontmatter ordering matters for any sidebar generation, one canonical numbering should be mirrored to both trees; if the JSON sidebars are the only source of order, consider deleting the field to stop the confusion. Decide.
- FAQ folder case mismatch:
de/docs/faq/csp/vsen/docs/faq/CSP/. Both currently work, but URLs differ between locales. Renaming the en folder to lowercase changes a public URL (needs redirect). Decide: rename + redirect, or accept. en/partner/(9 pages) has no German counterpart. Content was verified as clean English. If intentional (partner portal only in default locale), no action; otherwise needs translation. Decide.- Stale file at repo root:
vorschläge-für-text-verbesserugnen.md(filename typo included). It reviews the formerhome-experiment-1landing page; that folder no longer exists and every flagged item is already applied in the currentde.json/home components. Suggest deleting it. Decide. - du/Sie inconsistency:
de/demos/*pages use informal "du" while all other German pages use "Sie". Suggest converting the three demo pages to "Sie". Decide. - Azure AD naming:
de+en/docs/knowhow/auth/certificates_azure(and one mention in reasons-for-industry-browser) still say "Microsoft Azure AD"; the product has been Microsoft Entra ID since 2023, and the pages already reference the Entra Admin Center. Suggest "Microsoft Entra ID (formerly Azure AD)" on first mention.
Content freshness (needs domain knowledge)
de+en/docs/knowhow/android/versions: Honeywell/Zebra Android support table cites Android 11-14 roadmaps; several generations old by mid 2026.de+en/docs/knowhow/sap/cloudconnector: default credentials "Administrator/manage", port 8443, tools.hana.ondemand.com download link and a help link pinned to version "2022.4" are aging third-party-sourced claims; verify against current SAP docs.- Changelog cadence: latest entry is 2026-03-26; previous rhythm was roughly quarterly. If a newer version shipped, an entry is missing.
- Changelog 4.3.0 (2023-11-28) drift: two rows are "New feature" in en but "Verbesserung"/"Anpassung" in de, and row order differs. Content equivalent; align classification if desired. (All other 18 releases match exactly across languages.)
- Unverified product claims (consistent in both languages, flagged only): 7-day trial once per device; fully offline licensing; serial number readable only below Android 10; smartcard = DESFire NFC card; "certificate selection at login" default-on and its settings path; Android minimum 7.1/API 25, 2 GB RAM, 4 GB storage; version mapping 2026=v6, 2027=v7; MIFARE Classic FAQ claim ("not supported since Android 4.4" - actually depends on NFC chipset, not Android version).
Smaller editorial suggestions (optional)
- en
features/toolssection titled "Tools" while the app menu is "Useful Tools"; entools/demofrontmatter says "back-of-hand scanners" vs "backhand scanner" elsewhere. automation/scriptssidebar label is identical to its parent section name in both languages; a more specific label would help navigation.- de+en
start/index.mdfirst link labeled "Overview" while the target page is "What is TheFlex?". - de+en
cert_login/smartcard_loginopens with "as described in the previous article" but the referenced article now lives in another section. - de knowhow sap/destinations and cloudconnector omit the source citations the en versions carry.
- de+en
faq/white-screen: the manual-APK-sideloading workaround names no trusted source for the WebView APK. - de+en
caches/cache_clearfrontmatter mentions only the on-close trigger, not the start-page-change trigger. - en
features/automation/nfc_logintitle pattern differs from the de SEO-title pattern of its sibling pages. - en
proglovepage links to the German ProGlove site (https://www.proglove.com/de/). - README.md exists only in German.
- Landing page (
de/en index.md), contact and partner pages only mount React components; their visible copy lives in.vitepress/theme/react/and the i18n shims and was not part of this markdown review. A separate pass over those components would complete coverage (note: the old suggestions file for exactly that copy is already applied, see item 8).
3. Verification performed
- Every de/en parity addition was checked against the counterpart language; none invented.
- All 359+ unique internal links and every image/asset reference checked case-sensitively against the git index: zero broken links or missing assets remain.
- Anchor
#erklarung-aller-intune-json-keysand theSchritt6/7_skript.pngreferences flagged during review were verified as correct (VitePress strips umlauts in slugs; the files exist with capital S). - Frontmatter audit: every docs page has title and description; sidebar JSONs are structurally identical between de and en (78 links each, same order).
- Changelogs: all 19 releases present in both languages with matching versions, dates and contents (except item 14).
- No em or en dashes anywhere in de/, en/, README.md (repo rule).
npm run buildpasses cleanly on the final state.