Staging (#106)

* fix: intro description link

* fix: API reference links

Author: dynamsoft-h

_includes/sidelist-api.html

@@ -1,6 +1,2 @@
-<li><a href="{{ site.api }}index.html" class="otherLinkColour">API References</a>
-    <ul>
-        <li><a href="{{ site.api }}document-scanner.html" class="otherLinkColour">Document Scanner</a></li>
-        <li><a href="{{ site.api }}mobile-web-capture.html" class="otherLinkColour">Mobile Web Capture</a></li>
-    </ul>
+<li><a href="{{ site.api }}index.html" class="otherLinkColour">API Reference</a>
 </li>

api/document-scanner.md

@@ -8,20 +8,20 @@ keywords: Documentation, Mobile Web Capture, API Index
 description: Mobile Web Capture Documentation API Reference Index
 ---
 
-# API Reference Index  
+# API Reference Index
 
-## Scan Single-Page Documents  
+## Scan Single-Page Documents
 
-If you need to scan single-page documents and do not require handling PDF files (import or export), you only need **Dynamsoft Document Scanner (DDS)**, a component of **Mobile Web Capture (MWC)**. You can find its API reference here:  
+If you need to scan single-page documents and do not require handling PDF files (import or export), you only need **Dynamsoft Document Scanner (DDS)**, a component of **Mobile Web Capture (MWC)**. You can find its API reference here:
 
-- [Dynamsoft Document Scanner API Reference]({{ site.api }}document-scanner.html)  
+- [Dynamsoft Document Scanner API Reference]({{ site.api }}document-scanner.html)
 
-> See it in action with the [Dynamsoft Document Scanner Demo](https://demo.dynamsoft.com/document-scanner/).  
+> See it in action with the [Dynamsoft Document Scanner Demo](https://demo.dynamsoft.com/document-scanner/).
 
-## Scan Multi-Page Documents  
+## Scan Multi-Page Documents
 
-If you need to handle multi-page documents, PDF files, annotations, and more, you will need the full-featured **Mobile Web Capture (MWC)**. You can find its API reference here:  
+If you need to handle multi-page documents, PDF files, annotations, and more, you will need the full-featured **Mobile Web Capture (MWC)**. You can find its API reference here:
 
-- [Mobile Web Capture API Reference]({{ site.api }}mobile-web-capture.html)  
+- [Mobile Web Capture API Reference]({{ site.code-gallery }}}mobile-web-capture/api.html)
 
-> See it in action with the [Mobile Web Capture Demo](https://demo.dynamsoft.com/mobile-web-capture/).  
+> See it in action with the [Mobile Web Capture Demo](https://demo.dynamsoft.com/mobile-web-capture/).

api/index-v3.0.md

@@ -203,7 +203,7 @@ interface MobileWebCaptureConfig {
 
 ##### See Also
 
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
 
 #### Example
 

api/index.md

@@ -68,7 +68,7 @@ Keep TOC only for npm /github as readme
    2. `toolbarButtonsConfig`: Configures the button in the toolbar of the history view.
 12. `ddvResourcePath`: Paths to extra resources such as `.wasm` engine files and CSS files.
 
-API Reference: [`MobileWebCaptureConfig`]({{ site.api }}mobile-web-capture.html#mobilewebcaptureconfig)
+API Reference: [`MobileWebCaptureConfig`]({{ site.code-gallery }}}mobile-web-capture/api.html#mobilewebcaptureconfig)
 
 ## Overall UI and Workflow Customization
 
@@ -146,7 +146,7 @@ document.getElementById("initialFile").onchange = async function () {
 ```
 
 API Reference:
-- [`hasLaunched`]({{ site.api }}mobile-web-capture.html#haslaunched)
+- [`hasLaunched`]({{ site.code-gallery }}}mobile-web-capture/.html#haslaunched)
 - [`dispose`]({{ site.api }}mobile-web-capture.html#dispose)
 
 ### Scan Directly to Document

code-gallery/mobile-web-capture/api.md

@@ -12,7 +12,7 @@ description: Mobile Document Scanner JS Edition User Guide
 # Scan Single-Page Documents with Mobile Document Scanner
 
 > [!TIP]
-> Read the [Introduction]({{ site.introduction }}index.html) for an overview of the SDK architecture.
+> Read the [Introduction]({{ site.introduction }}index.html) for common use cases, an overview of the SDK architecture, and system requirements.
 
 Dynamsoft's **Mobile Document Scanner JavaScript Edition (MDS)** is a web SDK designed for scanning single-page documents. MDS captures images of the documents and enhances their quality to professional standards, making it an ideal tool for mobile document scanning.
 
@@ -209,7 +209,7 @@ First, download a copy of the resources:
 
 #### Point to Resources
 
-The library uses [`engineResourcePaths`]({{ site.api }}document-scanner.html#engineresourcepaths) to locate required Dynamsoft `node` dependencies by pointing to the location of the resources on your web server. The library also uses `scannerViewConfig.cameraEnhancerUIPath` similarly to set the path for the HTML UI template of the `ScannerView`. Later steps will place both the `node` dependencies and the HTML template in the local `dist` directory. Therefore, set `engineResourcePaths` in the MDS constructor to point to the local `dist` directory (along with setting your license key, and all other configurations):
+The library uses [`engineResourcePaths`]({{ site.api }}index.html#engineresourcepaths) to locate required Dynamsoft `node` dependencies by pointing to the location of the resources on your web server. The library also uses `scannerViewConfig.cameraEnhancerUIPath` similarly to set the path for the HTML UI template of the `ScannerView`. Later steps will place both the `node` dependencies and the HTML template in the local `dist` directory. Therefore, set `engineResourcePaths` in the MDS constructor to point to the local `dist` directory (along with setting your license key, and all other configurations):
 
 ```javascript
 const documentScanner = new Dynamsoft.DocumentScanner({
@@ -230,11 +230,11 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
-- [`DocumentScannerViewConfig`]({{ site.api }}document-scanner.html#documentscannerviewconfig)
-- [`engineResourcePaths`]({{ site.api }}document-scanner.html#engineresourcepaths)
-- [`cameraEnhancerUIPath`]({{ site.api }}document-scanner.html#cameraenhanceruipaths)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
+- [`DocumentScannerViewConfig`]({{ site.api }}index.html#documentscannerviewconfig)
+- [`engineResourcePaths`]({{ site.api }}index.html#engineresourcepaths)
+- [`cameraEnhancerUIPath`]({{ site.api }}index.html#cameraenhanceruipaths)
 
 #### Modify the Build Script
 
@@ -351,7 +351,7 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
 
 This step creates the **MDS** UI, which occupies the entire visible area of the browser window by default when launched. If needed, you can specify a container to restrict the UI's size. For more details, refer to [Confine DocumentScanner UI to a Specific Container](#example-1-confine-documentscanner-ui-to-a-specific-container).
 
@@ -366,7 +366,7 @@ const result = await documentScanner.launch();
 
 API Reference:
 
-- [`launch()`]({{ site.api }}document-scanner.html#launch)
+- [`launch()`]({{ site.api }}index.html#launch)
 
 This step launches the user into the document scanning workflow, beginning in the `DocumentScannerView`, where they can scan a document using one of three methods:
 
@@ -394,7 +394,7 @@ The workflow returns a scanned image object of type `CorrectedImageResult`. To d
 
 API Reference:
 
-- [`DocumentResult`]({{ site.api }}document-scanner.html#documentresult)
+- [`DocumentResult`]({{ site.api }}index.html#documentresult)
 
 The following code clears the result container and displays the scanned result as a canvas:
 
@@ -414,7 +414,7 @@ This section builds on the Hello World sample to demonstrate how to configure **
 
 ### `DocumentScannerConfig` Overview
 
-[`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig) is the primary configuration object for customizing **MDS**. It includes the following properties:
+[`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig) is the primary configuration object for customizing **MDS**. It includes the following properties:
 
 1. `license`: The license key.
 2. `container`: The HTML container for the entire workflow. If not specified (like in the Hello World Sample), one is created automatically.
@@ -493,8 +493,8 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
 
 #### Example 2: Only Show `DocumentScannerView`
 
@@ -510,8 +510,8 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
 
 #### Example 3: Specify Individual View Containers
 
@@ -546,8 +546,8 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
 
 #### Example 4: Scan Static Image Directly
 
@@ -614,9 +614,9 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
-- [`DocumentScannerViewConfig`]({{ site.api }}document-scanner.html#documentscannerviewconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
+- [`DocumentScannerViewConfig`]({{ site.api }}index.html#documentscannerviewconfig)
 
 ### View-Based Customization
 
@@ -671,9 +671,9 @@ This file defines the UI for `DocumentScannerView`. However, since files on the
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
-- [`DocumentScannerViewConfig`]({{ site.api }}document-scanner.html#documentscannerviewconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
+- [`DocumentScannerViewConfig`]({{ site.api }}index.html#documentscannerviewconfig)
 
 ##### Customizing the Scanning Region
 
@@ -695,7 +695,7 @@ interface ScanRegion {
 
 API Reference:
 
-[`ScanRegion`]({{ site.api }}document-scanner.html#scanregion)
+[`ScanRegion`]({{ site.api }}index.html#scanregion)
 
 Here is how the scanning region is set:
 
@@ -769,9 +769,9 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
-- [`DocumentCorrectionViewConfig`]({{ site.api }}document-scanner.html#documentcorrectionviewconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
+- [`DocumentCorrectionViewConfig`]({{ site.api }}index.html#documentcorrectionviewconfig)
 
 ##### Customizing Apply Button Callback
 
@@ -791,9 +791,9 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
-- [`DocumentCorrectionViewConfig`]({{ site.api }}document-scanner.html#documentcorrectionviewconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
+- [`DocumentCorrectionViewConfig`]({{ site.api }}index.html#documentcorrectionviewconfig)
 
 #### `DocumentResultView` Configuration
 
@@ -847,9 +847,9 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
-- [`DocumentResultViewConfig`]({{ site.api }}document-scanner.html#documentresultviewconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
+- [`DocumentResultViewConfig`]({{ site.api }}index.html#documentresultviewconfig)
 
 ##### Customizing the "Done" Button Callback
 
@@ -869,9 +869,9 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
-- [`DocumentResultViewConfig`]({{ site.api }}document-scanner.html#documentresultviewconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
+- [`DocumentResultViewConfig`]({{ site.api }}index.html#documentresultviewconfig)
 
 ##### Customizing the "Upload" Button
 
@@ -907,9 +907,9 @@ const documentScanner = new Dynamsoft.DocumentScanner({
 
 API Reference:
 
-- [`DocumentScanner()`]({{ site.api }}document-scanner.html#documentscanner)
-- [`DocumentScannerConfig`]({{ site.api }}document-scanner.html#documentscannerconfig)
-- [`DocumentResultViewConfig`]({{ site.api }}document-scanner.html#documentresultviewconfig)
+- [`DocumentScanner()`]({{ site.api }}index.html#documentscanner)
+- [`DocumentScannerConfig`]({{ site.api }}index.html#documentscannerconfig)
+- [`DocumentResultViewConfig`]({{ site.api }}index.html#documentresultviewconfig)
 
 ## Next Step
 

code-gallery/mobile-web-capture/customization-guide.md

@@ -14,5 +14,5 @@ description: Mobile Document Scanner JS Edition Documentation Homepage
     - [Customization Guide]({{ site.code-gallery }}mobile-web-capture/customization-guide.html)
     - [API Reference]({{ site.code-gallery }}mobile-web-capture/api.html)
   - [Frameworks]({{ site.code-gallery }}frameworks.html)
-- [API References]({{ site.api }}index.html)
+- [API Reference]({{ site.api }}index.html)
 - [Release notes]({{ site.release-notes }}index.html)