Skip to content

FAQ docs quality pass: fix broken links, mismatched H1s, orphaned phrasing - #30

Draft
lyzhang0113 wants to merge 16 commits into
previewfrom
faq-docs-quality-pass
Draft

FAQ docs quality pass: fix broken links, mismatched H1s, orphaned phrasing#30
lyzhang0113 wants to merge 16 commits into
previewfrom
faq-docs-quality-pass

Conversation

@lyzhang0113

@lyzhang0113 lyzhang0113 commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Repo-wide quality pass over the FAQ docs (excluding barcode-reader/web/debug/debug-mode.md, already fixed in #28), covering license/, mrz-scanner/, and all of barcode-reader/ (general, mobile, server, web). For each file, checked and fixed where confidently identifiable:

  • Missing/mismatched H1s (should match the link text used for that page in its directory's index.md)
  • Redundant/duplicate sections covering the same ground
  • Orphaned Q&A-snippet phrasing (e.g. "Yes —" or "this can be expanded" with no visible question/antecedent)
  • Broken internal links, most caused by the mobile/web directory reorgs (old flat paths pointing at files that moved into configuration/, capabilities/, debug/, scan-setting/, simulator/, or archive/)
  • Broken image references

No technical facts, code samples, or archived version-pinned content (-v9.6.40, -v10.4.2000, etc.) were changed — those directories were reviewed for structural/reference issues only, not modernized. */archive/* content was instead excluded from the Jekyll build entirely (originally #55, now merged directly into this branch), since none of it was linked from any live index or hosted on the site.

Also added along the way: README.md is now a plain contributor README (was a Jekyll page duplicating the homepage, unlinked from anywhere) and is excluded from the build; FAQ article-authoring conventions (frontmatter, H1 rules, linking, archive-directory rules) moved into a new AGENTS.md for agents/contributors writing new articles.

Follow-up issues (to be fixed directly on this branch)

Everything below needs a human decision or fact-check rather than a mechanical fix. Filed as separate issues so they can be worked one at a time:

Archived-content issues

These were all filed against content under */archive/*. Rather than fixing broken links/stranded content in place, the decision was to exclude those directories from the Jekyll build entirely, since nothing in them is linked from any live index or hosted on the site (originally PR #55, now merged and folded directly into this branch's history):

Test plan

  • Spot-check a sample of the changed pages render correctly (headings, links, images)
  • Confirm no build/link-checker regressions from the internal link fixes

🤖 Generated with Claude Code

Repo-wide quality pass covering license/, mrz-scanner/, and barcode-reader/
(general, mobile, server, web): repoint links broken by the mobile/web
directory reorgs, fix H1s that didn't match their index.md link text or
frontmatter, remove redundant/duplicate sections, and reword leftover
Q&A-snippet phrasing (unanswered "this"/"Yes—" references) into plain
statements. No technical facts, code samples, or archived version-pinned
content were altered.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This was referenced Aug 3, 2026
lyzhang0113 and others added 5 commits August 3, 2026 14:52
Closes #32

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The intro text already said the filter is enabled by default; the code
comment and settings table still said false. Starting from v4.0.0 the
default is true, so align both to match. Also fixes a stray extra
backtick breaking the code fence's closing line.

Closes #33

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…sion FAQs

The npm package backing DBR-JS has been renamed across major versions:
dynamsoft-javascript-barcode (v9) -> dynamsoft-barcode-reader (v10) ->
dynamsoft-barcode-reader-bundle (v11+). The v10 section previously used
`npm show <pkg> version`, which queries the npm registry's latest
published version rather than what's actually installed; switched both
files to `npm list <pkg>`, which reports the installed version. Also
fixed the v9 command's en-dash typo (`npm –v` -> was never valid) and
split the web/debug FAQ into separate v9/v10/v11+ sections since v10 and
v11 now use different package names.

Closes #34

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Closes #35

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@lyzhang0113
lyzhang0113 force-pushed the faq-docs-quality-pass branch from b52c45f to b7f9a84 Compare August 3, 2026 07:15
lyzhang0113 and others added 2 commits August 4, 2026 17:01
- barcode-reader/server/archive/unable-to-scan-aztec-code.md duplicated
  the live web-edition page (barcode-reader/web/scan-setting/unable-to-scan-aztec-code.md)
  and didn't belong in the server FAQ. Removed the file and its entry
  in server/configuration/index.md.

- barcode-reader/web/archive/use-of-onFrameRead-and-onUnduplicateRead.md
  stays in the repo as historical/archived content, but is no longer
  linked from web/configuration/index.md. Its filename typo
  (onUnduplicateRead vs onUniqueRead) isn't worth fixing now that it's
  unlinked archived content.

Closes #41, closes #42

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
barcode-reader/{mobile,server,web}/archive/ hold historical,
version-pinned content (e.g. v9.6.40, v10.4.2000 snapshots) that's
no longer linked from any live index or sidebar. Excluding them from
the build means they're kept in the repo for reference but are no
longer built, hosted, or listed in sitemap.xml.

Verified locally with `jekyll build`: the three directories are
absent from the generated _site output and from sitemap.xml, and the
two edited index pages (server/configuration, web/configuration)
render with no dangling references.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
lyzhang0113 and others added 8 commits August 4, 2026 17:11
Exclude archived FAQ content from Jekyll build; clean up archive references
README.md was a full Jekyll page (frontmatter, inline CSS grid)
duplicating the homepage (index.md), unlinked from anywhere in the
repo, and shipped in the site build/sitemap despite that. Replaced it
with a plain Markdown README describing the repo for contributors
(structure, build/deploy process, link-checking), and added it to
_config.yml's exclude list so Jekyll no longer builds or lists it in
sitemap.xml.

Verified locally with `jekyll build`: README.md is absent from the
generated _site output and from sitemap.xml.

Closes #53

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Dynamic Web TWAIN isn't part of Capture Vision, and its FAQ content
isn't in this repo — only linked to from the homepage.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
README.md should describe the repo for humans; the article structure,
frontmatter, linking, and archive-directory conventions are actionable
rules for whoever (human or agent) is writing/wiring FAQ content, so
they now live in AGENTS.md instead.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
A dedicated commit (7b72a73, "Remove back links on all faqs") stripped
these across ~50 files; these 3 were missed.

Closes #50

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
H1/title used to say "Secure Your License Key by Managing Domain
Binding," while both index.md entries linking to it said "change
domain binding of product key" — picked the latter phrasing (it
matches the filename and the actual step-by-step content) and applied
it consistently to the H1, frontmatter title/description, and both
index link texts. Filename already matched this phrasing, so no
rename was needed.

Closes #47

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Closes #46

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The page's title/H1/description/body are all specifically about
checking camera *permissions* programmatically, not general camera
availability. Updated both index.md link texts that pointed to it
(web/camera/index.md and web/index.md) to match.

Closes #43

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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