Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,17 @@ jobs:
- name: Install dependencies
run: yarn install --frozen-lockfile

# Whole-corpus check: the docs gate is a ratchet on changed files, so it
# cannot see a pre-existing violation nobody touched. This is what makes a
# framework value outside the enum - in docs OR in the code maps that read
# it - break the build instead of silently mis-resolving.
- name: Verify framework identifiers
run: yarn verify:frameworks

# Pins the membership of every derived framework map. The refactor risk
# here is not a crash, it is a map quietly gaining or losing an entry.
- name: Test framework registry
run: yarn test:frameworks

- name: Build documentation
run: yarn build
20 changes: 18 additions & 2 deletions docs-schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,30 @@ properties:
matrixscan-ar, matrixscan-pick, barcode-selection, barcode-generator,
id-capture, id-bolt, label-capture, parser, express, core, platform]

# Canonical framework slugs. These are the SSOT for every framework identifier
# in the repo: they are exactly the `/sdks/<slug>/` URL segments (with `hosted`
# for the /hosted/ tree), and src/components/utils/frameworks.ts must cover
# this same set - `yarn verify:frameworks` fails the build if the two drift.
#
# `kmp` (Kotlin Multiplatform) is documented only in the in-development docs
# version; that is tracked by UNRELEASED_FRAMEWORK_SLUGS in
# src/constants/unreleasedFrameworks.ts, not by leaving it out of this enum.
#
# Singular `framework` and plural `frameworks` share the set deliberately: a
# page states one platform or several, never two different vocabularies.
framework:
type: string
enum: [ios, android, web, react-native, flutter, cordova, capacitor, kmp,
titanium, linux, net-ios, net-android, hosted]

frameworks:
type: array
minItems: 1
uniqueItems: true
items:
type: string
enum: [ios, android, web, react-native, flutter, cordova, capacitor, titanium,
linux, net-ios, net-android, hosted]
enum: [ios, android, web, react-native, flutter, cordova, capacitor, kmp,
titanium, linux, net-ios, net-android, hosted]

version_status:
type: string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: "Define the input fields Custom Data Transfer collects during scanning in Scandit Express, and set each field's type and format."
framework: express
framework: hosted
product: express
sidebar_label: Input Configuration
keywords:
- express
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: "Configure how Custom Data Transfer structures, transforms, and exports scanned data to external systems in Scandit Express."
framework: express
framework: hosted
product: express
sidebar_label: Output Configuration
keywords:
- express
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: "Import and export data in Scandit Express using a configurable CSV file or Google Sheet, aligning formats with your system without coding."
framework: express
framework: hosted
product: express
sidebar_label: Overview
keywords:
- express
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: "Set up Bluetooth device pairing in Scandit Express to send scanned data from one device to another."
framework: express
framework: hosted
product: express
keywords:
- express
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: "Use Device Pairing in Scandit Express to transfer scanned barcode data in real time from a sender device to the receiver running your app."
framework: express
framework: hosted
product: express
sidebar_label: Overview
keywords:
- express
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: "Set up online device pairing in Scandit Express to send scanned data to a web application."
framework: express
framework: hosted
product: express
keywords:
- express
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/express/configuration/express-find.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
description: "Find Items in Scandit Express, powered by MatrixScan Find, speeds up picking by scanning many items and highlighting the right ones in AR."

framework: express
framework: hosted
product: express
keywords:
- express
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/express/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
description: "Overview of the configuration options available in Scandit Express and how to set them up."

toc_max_heading_level: 4
framework: express
framework: hosted
product: express
keywords:
- express
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/express/configuration/inventory-count.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: "Use the Inventory Count mode in Scandit Express for fast, accurate stock counting."
framework: express
framework: hosted
product: express
keywords:
- express
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/express/configuration/scan-labels.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: "Scan Labels in Scandit Express, powered by Smart Label Capture, reads multiple barcodes and printed text on a label in one scan."
framework: express
framework: hosted
product: express
keywords:
- express
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/express/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ description: "Install Scandit Express on iOS or Android and activate it to add b
sidebar_label: 'Installation'
displayed_sidebar: expressSidebar
sidebar_position: 1
framework: express
framework: hosted
product: express
keywords:
- express
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/express/getting-started/rollout.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ description: "Roll out Scandit Express to production with a mobile device manage
sidebar_label: 'Rollout via MDM/EMM'
displayed_sidebar: expressSidebar
sidebar_position: 2
framework: express
framework: hosted
product: express
keywords:
- express
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/express/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_position: 1
sidebar_label: 'Overview'
title: 'Scandit Express'
displayed_sidebar: expressSidebar
framework: express
framework: hosted
product: express
keywords:
- express
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "Advanced Options"
title: "Advanced Options"
displayed_sidebar: boltSidebar
toc_max_heading_level: 4
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
- advanced
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "API Overview"
title: "API Overview"
displayed_sidebar: boltSidebar
toc_max_heading_level: 4
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/callbacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "Callbacks"
title: "Callbacks"
displayed_sidebar: boltSidebar
toc_max_heading_level: 4
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
- callbacks
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/data-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "Data Handling"
title: "Data Handling"
displayed_sidebar: boltSidebar
toc_max_heading_level: 4
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
- data handling
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/document-selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "Document Selection"
title: "Document Selection"
displayed_sidebar: boltSidebar
toc_max_heading_level: 4
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
- document selection
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "Getting Started"
title: "Getting Started"
hide_title: false
displayed_sidebar: boltSidebar
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_position: 1
sidebar_label: "Overview"
title: "ID Bolt"
displayed_sidebar: boltSidebar
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
---
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
description: "Release notes for ID Bolt: new features, changes, and fixes by date."
toc_max_heading_level: 3
displayed_sidebar: boltSidebar
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
hide_title: true
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/text-overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "Text Overrides"
title: "Text Overrides"
displayed_sidebar: boltSidebar
toc_max_heading_level: 4
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
- customization
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/theming.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "Theming"
title: "Theming"
displayed_sidebar: boltSidebar
toc_max_heading_level: 4
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
- theming
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "Validators"
title: "Validators"
displayed_sidebar: boltSidebar
toc_max_heading_level: 4
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
- validators
Expand Down
3 changes: 2 additions & 1 deletion docs/hosted/id-bolt/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ sidebar_label: "Workflow Options"
title: "Workflow & Scanner Options"
displayed_sidebar: boltSidebar
toc_max_heading_level: 4
framework: bolt
framework: hosted
product: id-bolt
keywords:
- bolt
- workflow
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/add-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: "Add the Scandit Data Capture SDK to your .NET Android project: dep
sidebar_position: 1
toc_max_heading_level: 4
pagination_next: null
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/ai-powered-barcode-scanning.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: "import AIPoweredBarcodeScanning from '../../../partials/_ai-powered-barcode-scanning.mdx';"
toc_max_heading_level: 4
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: "Enable and configure barcode symbologies for Barcode Capture on .NET Android."
sidebar_position: 3
pagination_next: null
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/barcode-capture/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: "Add Barcode Capture to your .NET Android app: configure the mode, set up the camera and view, and handle scanned barcodes."
sidebar_position: 2
pagination_prev: null
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/barcode-selection/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: "Add Barcode Selection to your .NET Android app so users can tap or aim to select a single barcode among many."
sidebar_position: 2
pagination_next: null
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/barcode-selection/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: "Barcode Selection lets users tap or aim to pick one barcode among many in your .NET Android app."
sidebar_position: 1
pagination_prev: null
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/batch-scanning.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: "Scan and process many barcodes in one session in your .NET Android app with the Scandit Data Capture SDK."
pagination_prev: null
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/id-capture/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: "Advanced ID Capture settings for .NET Android: configure document types, extracted fields, and verification."
sidebar_position: 4
pagination_next: null
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/id-capture/get-started.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: "Add ID Capture to your .NET Android app to scan and extract data from IDs such as driver's licenses, passports, and ID cards."
sidebar_position: 2
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/id-capture/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: About ID Capture
sidebar_position: 1
toc_max_heading_level: 4
pagination_prev: null
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/id-capture/supported-documents.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ hide_title: true
toc_min_heading_level: 2
toc_max_heading_level: 4
sidebar_position: 3
framework: netAndroid
framework: net-android
keywords:
- netAndroid
---
Expand Down
Loading
Loading