Docs cleanup: retitle Page Unavailable, fix marketing copy, align procedures#358
Closed
raffaelefarinaro wants to merge 1 commit into
Closed
Docs cleanup: retitle Page Unavailable, fix marketing copy, align procedures#358raffaelefarinaro wants to merge 1 commit into
raffaelefarinaro wants to merge 1 commit into
Conversation
…cedures Phase 1 of cleanup based on external documentation review: - Retitle 70 "Page Unavailable" pages (linux, titanium, web, .NET) to feature- and framework-specific headings (e.g. "MatrixScan Pick is not available on Linux") with matching frontmatter descriptions and a body pointing to the framework switcher. Improves SEO and information scent. - Rewrite SparkScan trigger and AI-Powered Barcode Scanning intro sentences to remove marketing tone and unclear phrasing. - Split the "see the Installation guide for …" sentence in the web Barcode Capture Get Started so the action and the redirect stop sharing one sentence. - Rename the H1 of web and capacitor getting-started.md from "Quick Start Guide" to "Get Started" to match the other 10 frameworks. - Rewrite the intro-step lists on the MatrixScan and MatrixScan AR web Get Started pages so the bullets map 1:1 to the H2 sections (with anchor links).
Contributor
Author
|
Reopening with renamed branch |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Phase 1 of the docs cleanup based on the external review (Kawa). Six small, verifiable items, no IA/sidebar changes, no new files.
linux,titanium,web,net/android,net/ios. New H1 is<Feature> is not available on <Framework>, with a matching frontmatter description and a body that points users at the framework switcher. The current "Page Unavailable" title hurts SEO/info-scent and reads like a broken page.docs/partials/advanced/_sparkscan-customization.mdx— SparkScan trigger button paragraph.docs/partials/_ai-powered-barcode-scanning.mdx— "induce errors / intentional versus accidental duplicate scans" opener.docs/sdks/web/barcode-capture/get-started.mdso the action and the redirect no longer share one sentence.docs/sdks/web/getting-started.mdanddocs/sdks/capacitor/getting-started.md. Every other framework already uses "Get Started" — these two were outliers. Filenames unchanged, no sidebar impact.docs/sdks/web/matrixscan/get-started.mdanddocs/sdks/web/matrixscan-ar/get-started.md. Bullets now map 1:1 to the H2 headings and link to them via anchors.Out of scope (deferred): release-notes ↔ migration-guide cross-linking, barcode-symbology FAQ merge, Core Concepts rework, Advanced Configurations heading cleanup, deleting orphan Page Unavailable files, broader IA restructure, Algolia synonyms.
Test plan
yarn buildsucceeds locally (no new warnings beyond pre-existing).sdks/titanium/sparkscan/get-started), the SparkScan advanced page (new sentence renders), the AI-Powered Barcode Scanning page (new sentence renders), andsdks/web/getting-started(H1 now "Get Started")./sdks/web/matrixscan/get-startedand/sdks/web/matrixscan-ar/get-startedin preview — bullet anchor links should jump to the matching H2 sections.