Skip to content

Share FAQ answers with product-specific pages and assets - #69

Merged
lyzhang0113 merged 4 commits into
previewfrom
shared-faq-includes
Sep 30, 2026
Merged

lyzhang0113 merged 4 commits into
previewfrom
shared-faq-includes

Conversation

@lyzhang0113

Copy link
Copy Markdown
Contributor

Changes

  • Replace shared FAQ filesystem symlinks with regular Barcode Reader and MRZ Scanner pages that keep their own frontmatter and question H1 while including common answer bodies.
  • Preserve the MRZ Scanner iOS 27 camera-preview title and description from d85808c.
  • Publish license FAQs only under product paths; remove the redundant bare /faq/license/ pages and sitemap scope.
  • Store the six offline-registration screenshots once under assets/license/ and reference them from both product pages.

Verification

  • Local Jekyll build completed; both product camera FAQ pages rendered their shared answer and images, with MRZ-specific title and description.
  • Both product offline-registration pages loaded all six screenshots in a local browser.
  • python check_links.py reported 31 existing issues in 19 unrelated files; no touched FAQ was flagged.

Copilot AI balanced review requested due to automatic review settings September 30, 2026 07:44

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Several MRZ pages expose Barcode Reader-specific links, APIs, presets, and metadata as MRZ instructions.

Review effort: Balanced
Findings: 5 Medium severity

Open (5)
What changed in this PR

Moves reusable FAQ answers into shared includes while preserving product-specific pages, URLs, metadata, and centralized assets.

Changes:

  • Adds product-scoped Barcode Reader and MRZ Scanner license pages backed by shared answer bodies.
  • Shares camera-preview guidance and offline-registration screenshots.
  • Updates repository guidance and removes obsolete bare-license sitemap handling.
File Description
README.md Documents shared FAQ and asset structure.
AGENTS.md Adds authoring rules for shared content.
_config.yml Removes obsolete bare-license sitemap exclusion.
_includes/​shared/​camera-preview-renders-incorrectly-ios.md Centralizes camera-preview guidance.
barcode-reader/​web/​camera/​camera-preview-renders-incorrectly-ios.md Uses the shared camera answer.
mrz-scanner/​general/​camera-preview-renders-incorrectly-ios.md Adds an MRZ-specific camera page.
_includes/​shared/​license/​index.md Provides shared license navigation.
_includes/​shared/​license/​dbr-free-trial.md Extracts trial guidance.
_includes/​shared/​license/​enable-supported-barcode-format.md Extracts format-license troubleshooting.
_includes/​shared/​license/​ensure-no-overuse.md Extracts concurrency guidance.
_includes/​shared/​license/​expand-quota-for-runtime-license.md Extracts quota guidance.
_includes/​shared/​license/​how-hardware-is-bind-to-license.md Extracts hardware-binding guidance.
_includes/​shared/​license/​how-license-tracking-works.md Adds shared tracking guidance.
_includes/​shared/​license/​new-license-required-per-device-licensing.md Extracts per-device guidance.
_includes/​shared/​license/​offline-registration-license.md Centralizes offline registration and assets.
_includes/​shared/​license/​sdk-works-without-internet.md Extracts offline-use guidance.
_includes/​shared/​license/​track-license.md Extracts device-tracking guidance.
_includes/​shared/​license/​troubleshooting-unauthorized-device-clone-detected.md Extracts clone-error troubleshooting.
barcode-reader/​license/​index.md Adds Barcode Reader license navigation.
barcode-reader/​license/​dbr-free-trial.md Adds the product-scoped trial page.
barcode-reader/​license/​enable-supported-barcode-format.md Adds format-license troubleshooting page.
barcode-reader/​license/​ensure-no-overuse.md Adds concurrency guidance page.
barcode-reader/​license/​expand-quota-for-runtime-license.md Adds quota guidance page.
barcode-reader/​license/​how-hardware-is-bind-to-license.md Adds hardware-binding page.
barcode-reader/​license/​how-license-tracking-works.md Uses the shared tracking answer.
barcode-reader/​license/​new-license-required-per-device-licensing.md Adds per-device licensing page.
barcode-reader/​license/​offline-registration-license.md Adds offline-registration page.
barcode-reader/​license/​sdk-works-without-internet.md Adds offline-use page.
barcode-reader/​license/​track-license.md Adds device-tracking page.
barcode-reader/​license/​troubleshooting-unauthorized-device-clone-detected.md Adds clone-error page.
mrz-scanner/​license/​index.md Adds MRZ license navigation.
mrz-scanner/​license/​dbr-free-trial.md Adds an MRZ-path trial page.
mrz-scanner/​license/​enable-supported-barcode-format.md Adds an MRZ-path format page.
mrz-scanner/​license/​ensure-no-overuse.md Adds an MRZ-path concurrency page.
mrz-scanner/​license/​expand-quota-for-runtime-license.md Adds quota guidance page.
mrz-scanner/​license/​how-hardware-is-bind-to-license.md Adds hardware-binding page.
mrz-scanner/​license/​how-license-tracking-works.md Adds tracking guidance page.
mrz-scanner/​license/​new-license-required-per-device-licensing.md Adds per-device licensing page.
mrz-scanner/​license/​offline-registration-license.md Adds an MRZ-path registration page.
mrz-scanner/​license/​sdk-works-without-internet.md Adds offline-use page.
mrz-scanner/​license/​track-license.md Adds device-tracking page.
mrz-scanner/​license/​troubleshooting-unauthorized-device-clone-detected.md Adds clone-error page.
assets/​license/​activate.jpg Adds activation screenshot.
assets/​license/​cp-license.jpg Adds license-copy screenshot.
assets/​license/​offline-activate.jpg Adds offline-activation screenshot.
assets/​license/​submit-uuid.jpg Adds UUID-submission screenshot.
assets/​license/​uuid-tool.jpg Adds UUID-tool screenshot.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread mrz-scanner/license/dbr-free-trial.md
Comment thread mrz-scanner/license/enable-supported-barcode-format.md
Comment thread mrz-scanner/license/ensure-no-overuse.md
Comment thread mrz-scanner/license/index.md
Comment thread mrz-scanner/license/offline-registration-license.md
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.

2 participants