Preview

[lyzhang0113]

This pull request introduces substantial improvements to the documentation and FAQ content organization for the Dynamsoft FAQ site. The main focus is on clarifying article authoring conventions, updating navigation and linking practices, and refining several FAQ articles for accuracy and consistency. Additionally, the Jekyll site configuration is updated to exclude archived content and the plain README.md from the build. Below are the most important changes:

Documentation and Authoring Guidelines

• Added a comprehensive agent guide in AGENTS.md detailing FAQ article structure, linking, directory conventions, and archiving rules for both AI agents and human contributors.
• Simplified and clarified README.md to focus on repo purpose, article authoring, build/deploy process, and link checking; removed old frontmatter and homepage grid.

Site Configuration

• Updated _config.yml to exclude all archive directories and README.md from the Jekyll build, ensuring only current content is hosted and indexed.

FAQ Content Corrections and Improvements

• Fixed and clarified instructions and descriptions in several FAQ articles, including correcting outdated or confusing text, updating directory references, and improving section headings:
  • Updated solution steps and clarified the known issue for CODE_128 decoding in barcode-reader/general/avoid-incorrect-barcode-results.md.
  • Improved package version instructions and fixed code snippets in barcode-reader/general/check-current-version.md. [1] [2]
  • Fixed directory references and improved navigation in mobile archive and configuration articles. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

These changes collectively improve the maintainability, clarity, and navigability of the FAQ site.

Issues fixed

• Closes Python sample in enable-supported-barcode-format.md has stray double-space #32 — Python sample in enable-supported-barcode-format.md has stray double-space
• Closes performance-optimization.md contradicts itself on enableMultiFrameCrossFilter default #33 — performance-optimization.md contradicts itself on enableMultiFrameCrossFilter default
• Closes check-current-version.md: npm version-check command is wrong (en dash + wrong command) #34 — check-current-version.md: npm version-check command is wrong (en dash + wrong command)
• Closes check-current-version.md: Java sample missing 'new' when constructing BarcodeReaderModule #35 — check-current-version.md: Java sample missing 'new' when constructing BarcodeReaderModule
• Closes server/configuration/index.md: Aztec-code archive entry may not belong in server FAQ #41 — server/configuration/index.md: Aztec-code archive entry may not belong in server FAQ
• Closes check-camera.md index link text doesn't match its actual content #43 — check-camera.md index link text doesn't match its actual content
• Closes is-https-required.md: frontmatter title says 'HTTPs', H1 says 'HTTPS' #46 — is-https-required.md: frontmatter title says 'HTTPs', H1 says 'HTTPS'
• Closes change-domain-binding-of-product-key.md: H1 doesn't match index link text or frontmatter title #47 — change-domain-binding-of-product-key.md: H1 doesn't match index link text or frontmatter title
• Closes pop-up-window-during-trail-process.md: filename typo, 'trail' should be 'trial' #49 — pop-up-window-during-trail-process.md: filename typo, 'trail' should be 'trial' (fixed via the file rename/rewrite already on preview)
• Closes Stray '<< Back to FAQ index' links missed by a prior cleanup #50 — Stray '<< Back to FAQ index' links missed by a prior cleanup
• Closes README.md is an unlinked duplicate of the homepage, not excluded from the site build #53 — README.md is an unlinked duplicate of the homepage, not excluded from the site build

Also fixed, found by Copilot's automated review of #30 (no standalone issues filed):

• mrz-scanner/general/ui-customization.md: code fence closed with four backticks instead of three, breaking rendering for the rest of the page.
• Aligned frontmatter title/description with the H1 in five files where the H1 was updated but the old phrasing was left in metadata: license/how-hardware-is-bind-to-license.md, license/dbr-free-trial.md, barcode-reader/server/configuration/non-english-characters.md, barcode-reader/web/camera/stop-camera-to-open-right-away.md, barcode-reader/general/avoid-incorrect-results.md.
• barcode-reader/mobile/configuration/no-camera-enhancer.md: description said "DBR Android FAQs" even though the page covers both Android and iOS.
• barcode-reader/mobile/index.md: link text still said generic "Template Support"; matched the corrected label already used in scan-setting/index.md.

Not included in this PR (still open, need a human decision or fact-check): #31, #44, #45, #48, #51, #52, #54.