Skip to content

Commit 1e7af04

Browse files
committed
Restructure user guide to prioritize BarcodeScanner API
- Rename barcode-scanner.md to index.md (now the default entry point) - Rename index.md to foundational-api.md (advanced use cases) - Update all internal links to reflect new file structure - Add prominent banner to foundational API guide redirecting most users to BarcodeScanner - Add AI-friendly metadata for better documentation assistance - Update metadata/titles to reflect guide purposes
1 parent 1bb5a60 commit 1e7af04

8 files changed

Lines changed: 946 additions & 941 deletions

File tree

_includes/samples_index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1049,7 +1049,7 @@
10491049
<span
10501050
class="guide-badge"
10511051
title="View user guide documentation"
1052-
onclick="event.stopPropagation(); window.open('https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/barcode-scanner.html', '_blank'); return false;"
1052+
onclick="event.stopPropagation(); window.open('https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/index.html', '_blank'); return false;"
10531053
>
10541054
<svg width="20" height="20" viewBox="0 0 16 16" fill="white">
10551055
<path

_includes/sidelist-programming/programming-javascript.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<ul lang="javascript">
88
<li lang="javascript">
99
<a
10-
href="{{ site.js }}user-guide/barcode-scanner.html"
10+
href="{{ site.js }}user-guide/index.html"
1111
style="cursor: pointer; color: #3c3c3c"
1212
>Start with RTU-BarcodeScanner</a
1313
>
@@ -27,7 +27,7 @@
2727
<ul lang="javascript">
2828
<li lang="javascript">
2929
<a
30-
href="{{ site.js }}user-guide/index.html"
30+
href="{{ site.js }}user-guide/foundational-api.html"
3131
style="cursor: pointer; color: #3c3c3c"
3232
>Get Started</a
3333
>

programming/javascript/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Dynamsoft Barcode Reader (DBR) can be used in JavaScript to add barcode reading
1818

1919
To get a fast start, you can
2020

21-
- read the [User Guide](user-guide/barcode-scanner.html), or
21+
- read the [User Guide](user-guide/index.html), or
2222
- try the [Samples and Demos](samples-demos/)
2323

2424
The following describes the highlights of DBR JavaScript edition (DBR-JS) version 11.x.
@@ -36,7 +36,7 @@ With `BarcodeScanner`, you can:
3636
- Focus on your application logic without worrying about camera setup, UI rendering, or lifecycle management.
3737

3838
> [!TIP]
39-
> You can either get a [quick start with the BarcodeScanner APIs](user-guide/barcode-scanner.html) or experience a highly customizable [development with the foundational APIs](user-guide/index.html). If you're just starting out, we highly recommend using the `BarcodeScanner` class for the best balance of simplicity, performance, and user experience.
39+
> You can either get a [quick start with the BarcodeScanner APIs](user-guide/index.html) or experience a highly customizable [development with the foundational APIs](user-guide/foundational-api.html). If you're just starting out, we highly recommend using the `BarcodeScanner` class for the best balance of simplicity, performance, and user experience.
4040
4141
---
4242

@@ -92,7 +92,7 @@ DBR-JS v11.x is based on [Dynamsoft Capture Vision]({{site.dcvb_architecture}})
9292

9393
## Next Step
9494

95-
Read the [User Guide](user-guide/barcode-scanner.html) to start building your own websites with barcode reading capabilities.
95+
Read the [User Guide](user-guide/index.html) to start building your own websites with barcode reading capabilities.
9696

9797
## See Also
9898

programming/javascript/upgrade-guide/10to11.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ The Dynamsoft Barcode Reader JavaScript edition has been refactored to integrate
7272
>
7373
> Dynamsoft's ongoing feature development is based on the new DCV architecture. By upgrading to v11, you'll gain access to improved performance and new capabilities.
7474
75-
Due to the architectural changes, **a significant rewrite of your existing code is required**. we recommend you to follow the [User Guide](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/barcode-scanner.html) and re-write your codes.
75+
Due to the architectural changes, **a significant rewrite of your existing code is required**. we recommend you to follow the [User Guide](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/index.html) and re-write your codes.

programming/javascript/user-guide/barcode-scanner.md

Lines changed: 0 additions & 281 deletions
This file was deleted.

programming/javascript/user-guide/explore-features/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ permalink: /programming/javascript/user-guide/explore-features/index.html
1414

1515
Once you have got an application running with Dynamsoft Barcode Reader JavaScript edition, you can explore the many features of the SDK to see how to make the best out of the SDK.
1616

17-
> If you are just getting started with Dynamsoft Barcode Reader JavaScript Edition, we recommend that you read [Get Started](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/index.html) first.
17+
> If you are just getting started with Dynamsoft Barcode Reader JavaScript Edition, we recommend that you read the [BarcodeScanner User Guide](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/index.html) first.
1818
1919
## Basic Features
2020

0 commit comments

Comments
 (0)