Skip to content

Exclude archived FAQ content from Jekyll build; clean up archive references - #55

Merged
lyzhang0113 merged 2 commits into
faq-docs-quality-passfrom
archive-cleanup
Aug 4, 2026
Merged

Exclude archived FAQ content from Jekyll build; clean up archive references#55
lyzhang0113 merged 2 commits into
faq-docs-quality-passfrom
archive-cleanup

Conversation

@lyzhang0113

@lyzhang0113 lyzhang0113 commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to the discussion on #30 about */archive/* content: these directories hold historical, version-pinned FAQ snapshots (e.g. -v9.6.40, -v10.4.2000) that are no longer linked from any live index or sidebar. Decision: keep the files in the repo for reference, but stop building/hosting/sitemap-listing them. Also folds in a related cleanup: README.md was a Jekyll page duplicating the homepage and unlinked from anywhere, so it's now a plain contributor README, also excluded from the build.

  1. Removed barcode-reader/server/archive/unable-to-scan-aztec-code.md and its entry in server/configuration/index.md — it 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. Fixes server/configuration/index.md: Aztec-code archive entry may not belong in server FAQ #41.
  2. Unlinked barcode-reader/web/archive/use-of-onFrameRead-and-onUnduplicateRead.md from web/configuration/index.md, but kept the file itself as archived content. Its filename typo (onUnduplicateRead vs onUniqueRead) isn't worth fixing now that it's unlinked. Closed Filename typo: onUnduplicateRead should be onUniqueRead #42 (won't-fix, not a real fix).
  3. Added exclude: in _config.yml for barcode-reader/mobile/archive, barcode-reader/server/archive, and barcode-reader/web/archive. Verified locally with an actual jekyll build: all three directories are absent from the generated _site output and from sitemap.xml, and both edited index pages render with no dangling links.
  4. Rewrote README.md as a plain repo-contributor README (structure, build/deploy process, link-checking tool) instead of a Jekyll page, and added it to _config.yml's exclude: list. Verified locally that it no longer appears in the build output or sitemap.xml. Fixes README.md is an unlinked duplicate of the homepage, not excluded from the site build #53.

Related issues — already closed as won't-fix

These were all filed against content inside barcode-reader/mobile/archive/. Once this PR merges, none of that content is built or reachable on the live site, so the broken links / stranded content / unresolved variable they describe have no user-facing impact. Already closed (won't-fix, wontfix label) ahead of merge:

Test plan

  • Local jekyll build confirms archive dirs and README.md are excluded from _site and sitemap.xml
  • Confirm no CI/deploy step depends on these paths existing in the build output

🤖 Generated with Claude Code

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>
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.

1 participant