typo fix. add typo check workflow and config file.

Assisted-by: Deepseek-V4-Flash:0731 vscode copilot
Assisted-by: GLM:5.2 vscode copilot
Assisted-by: Longcat:2.0 vscode copilot

Author: sunflower2333

.codespellrc

@@ -0,0 +1,19 @@
+# codespell configuration
+# Docs: https://github.com/codespell-project/codespell
+
+[codespell]
+# Files / paths to skip entirely
+skip = .git,node_modules,.vitepress,.github,package-lock.json,*.svg,*.png,*.jpg,*.jpeg,*.gif,*.webp,*.ico,*.woff,*.woff2,*.ttf,*.eot
+
+# Built-in dictionaries to check
+builtin = clear,rare,informal,usage
+
+# Words to ignore (technical terms, codenames, commands, etc.)
+# Entries are comma-separated, case-insensitive.
+# NOTE: keep on a single line - configparser treats "\" as an escape char,
+# so backslash line-continuation would corrupt the word list.
+ignore-words-list = abl,reserv,slave,te
+
+# Extra words that are always considered correct
+# (one word per line, lowercase)
+# ignore-words.txt is maintained next to this file

.github/workflows/lint-docs.yaml

@@ -0,0 +1,36 @@
+name: Lint Docs
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Markdown & spelling
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 22
+          cache: 'npm'
+          cache-dependency-path: 'package-lock.json'
+
+      - name: Install dependencies
+        run: npm ci --legacy-peer-deps
+
+      - name: Markdown lint (markdownlint-cli2)
+        run: npm run lint:md
+
+      - name: Spell check (codespell)
+        run: |
+          python3 -m venv .venv-spell
+          .venv-spell/bin/pip install --quiet codespell
+          .venv-spell/bin/codespell --config .codespellrc

.gitignore

@@ -3,4 +3,5 @@ node_modules
 dist
 .npmrc
 .idea
-.vitepress/cache
+.vitepress/cache
+.venv-spell

.markdownlint-cli2.yaml

@@ -0,0 +1,85 @@
+# Markdownlint configuration.
+# Docs: https://github.com/DavidAnson/markdownlint/blob/main/doc/README.md
+# CLI:  https://github.com/DavidAnson/markdownlint-cli2
+
+config:
+  default: true
+
+  # ---- Rules relaxed to match the existing doc style ----
+
+  # MD001 - heading-increment
+  # Guides use headings inside blockquotes (e.g. "> ### Part 1").
+  MD001: false
+
+  # MD004 - ul-style
+  # Lists mix "-" and "+" markers.
+  MD004: false
+
+  # MD007 - ul-indent
+  # Top-level list items are sometimes indented for readability.
+  MD007: false
+
+  # MD013 - line-length
+  # The docs intentionally use long lines (e.g. tables, links, CJK text).
+  MD013: false
+
+  # MD022 - blanks-around-headings
+  # Headings are often immediately followed by content.
+  MD022: false
+
+  # MD024 - no-duplicate-heading
+  # Duplicate headings are common in guides (e.g. "Part 1", "Part 2" sections).
+  MD024:
+    siblings_only: true
+
+  # MD025 - single-title
+  # Some pages use multiple top-level headings (e.g. section dividers).
+  MD025: false
+
+  # MD026 - no-trailing-punctuation
+  # Headings may end with a period in some existing docs.
+  MD026: false
+
+  # MD028 - no-blanks-blockquote
+  # Blank lines inside/around blockquotes are used for readability.
+  MD028: false
+
+  # MD029 - ol-prefix
+  # Step headings use numbers like "3.", "4.", "5." directly.
+  MD029: false
+
+  # MD031 - blanks-around-fences
+  # Fenced code blocks are often glued to the surrounding text.
+  MD031: false
+
+  # MD032 - blanks-around-lists
+  # Lists are often glued to the surrounding text.
+  MD032: false
+
+  # MD033 - no-inline-html
+  # VitePress supports HTML components inside Markdown (e.g. <Badge />, <div>).
+  MD033: false
+
+  # MD035 - hr-style
+  # Horizontal rules mix "---", "___" and "__".
+  MD035: false
+
+  # MD036 - no-emphasis-as-heading
+  # Existing docs use bold text (**Device/**) as de-facto headings.
+  MD036: false
+
+  # MD041 - first-line-heading
+  # VitePress pages may start with YAML frontmatter and have no top-level H1.
+  MD041: false
+
+  # MD058 - blanks-around-tables
+  # Tables are often glued to the surrounding text.
+  MD058: false
+
+globs:
+  - "**/*.md"
+
+ignores:
+  - "node_modules/**"
+  - ".vitepress/**"
+  - "package-lock.json"

.vitepress/en.ts

@@ -14,11 +14,11 @@ export const en = defineConfig({
       '/': { base: '', items: sidebarDocs() },
     },
     editLink: {
-      text: 'Edit this page on Github',
+      text: 'Edit this page on GitHub',
       pattern: 'https://github.com/Project-Aloha/DocumentWebsite/edit/main/:path'
     },
     footer: {
-      copyright: `Site CC BY-NC-SA 4.0 | CopyRight © 2022-${new Date().getFullYear()} Project-Aloha`
+      copyright: `Site CC BY-NC-SA 4.0 | Copyright © 2022-${new Date().getFullYear()} Project-Aloha`
     },
   }
 })

.vitepress/zh.ts

@@ -30,7 +30,7 @@ export const zh = defineConfig({
       next: '下一页'
     },
     editLink: {
-      text: '在 Github 上编辑此页',
+      text: '在 GitHub 上编辑此页',
       pattern: 'https://github.com/Project-Aloha/DocumentWebsite/edit/main/:path'
     },
     footer: {

DualBoot/Config.md

@@ -5,13 +5,13 @@ If you do not need it, set the two values to 0.
 
 ## Format
   - A config file should only contain the following contents.
-  ```
+  ```text
   StackBase=0x00000000
   StackSize=0x00000000
   RestartReasonAddress=0x00000000
   ```
   - The value after `=` must be hex number.
-  - Config file not in this format will cause unexceptional behavior.
+  - Config file not in this format will cause unexpected behavior.
 
 ## How to get these values
   - `StackBase`
@@ -29,5 +29,4 @@ If you do not need it, set the two values to 0.
     android:/# printf "RestartReasonAddress=0x%x\n" $((0x$(realpath /sys/firmware/devicetree/base/soc/qcom\,msm-imem@*/restart_reason@* | awk -F'[@/]' '{print $(NF-2)"+0x"$(NF)}')))
     RestartReasonAddress=0x146bf65c
     ```
-  
-    
+  

DualBoot/Introduction.md

@@ -1,7 +1,7 @@
 ## DualBoot Kernel Patcher
 > Based on [SurfaceDuoDualBootKernelImagePatcher](https://github.com/WOA-Project/SurfaceDuoDualBootKernelImagePatcher).  
 
-Kernel Patcher is a tool can inject shell codes into Linux kernel header, which can help use archive dual boot.  
+Kernel Patcher is a tool can inject shell codes into Linux kernel header, which can help achieve dual boot.  
 Can also do some more interesting things like replace dtb provided by abl with ours, select different linux kernel etc.
 
 ## DualBoot Boot Order
@@ -10,7 +10,7 @@ flowchart TD
   bl[Bootloader]
   subgraph patched_kernel[Patched Kernel]
     subgraph ori_kernel[Origin Linux Kernel]
-      subgraph shellcode[ShellCodeᅟᅠ]
+      subgraph shellcode[ShellCode]
         start_shellcode(Entry of Shell Code)
         check_memory{Check flags in memory}
         copy_fd[Copy UEFI FD to UEFI stack region]
@@ -54,4 +54,4 @@ block-beta
   shell_code["Shell Code"]
   rest_kernel["Rest of Kernel"]
   fd["UEFI FD"]
-```
+```

DualBoot/PatchKernel.md

@@ -3,7 +3,7 @@
 
 ## Prepare
 - An android device.
-- Download `UEFI FD` file from [Github Action](https://github.com/Project-Aloha/mu_aloha_platforms/actions)(You may need to login to download artifacts) or [Release Page](https://github.com/Project-Aloha/mu_aloha_platforms/releases) of uefi repository.
+- Download `UEFI FD` file from [GitHub Action](https://github.com/Project-Aloha/mu_aloha_platforms/actions)(You may need to login to download artifacts) or [Release Page](https://github.com/Project-Aloha/mu_aloha_platforms/releases) of uefi repository.
 - `Magiskboot` for your environment, there are prebuilt binaries on github.
 - DualBoot kernel patcher binary and shellcode binaries for your devices from [release page](https://github.com/Project-Aloha/DualBootKernelPatcher/releases) or [action page](https://github.com/Project-Aloha/DualBootKernelPatcher/actions).
 
@@ -13,9 +13,9 @@
 
 ## Steps
 > Assume you have done the following steps on your android device.
->  1. Root your device with magisk.
->  2. Downloaded and installed termux.
->  3. Installed root-repo and tsu in termux with apt.
+> 1. Root your device with magisk.
+> 2. Downloaded and installed termux.
+> 3. Installed root-repo and tsu in termux with apt.
 
 - Get Android Boot Image.
   + The boot image usually can be found at `/dev/block/by-name/boot` or `/dev/block/by-name/boot_a` (or _b).
@@ -27,7 +27,7 @@
   ```
 
 - Unpack it with magiskboot.
-  + If your device was rooted by magisk, there should be an magiskboot binary at `/data/adb/magisk/magiskboot`
+  + If your device was rooted by magisk, there should be a magiskboot binary at `/data/adb/magisk/magiskboot`
   + By the way you can press the `tab` button in termux to automatically fill path, instead of typing the characters one by one.
   + Do Unpack
   ```bash
@@ -61,7 +61,7 @@ Please do not patch a patched kernel.
 - Apply patch with dualboot kernel patcher.
   + Assume the patcher and shellcodes and config you downloaded above was saved at `/sdcard/Download/`
   + Unpack these zips with these cmds, or extract in file manager.
-  ```
+  ```bash
   unzip /sdcard/Download/Shellcodes.zip
   unzip /sdcard/Download/DualBootKernelPatcher-Linux-arm64.zip
   unzip /sdcard/Download/Config.zip
@@ -81,7 +81,7 @@ Please do not patch a patched kernel.
   mv patched_kernel kernel
   /data/adb/magisk/magiskboot repack boot.img
   ```
-  + You will get a file named `new-boot.img` if magiskboot success.
+  + You will get a file named `new-boot.img` if magiskboot succeeds.
 
 - Test with fastboot.
   + Send `new-boot.img` to your computer:
@@ -100,13 +100,13 @@ Please do not patch a patched kernel.
   + See if the device is entering a correct os.
 
 - Flash boot image into disk
-  + If everything goes well and boot image was backuped. You can flash boot image into disk now. Then no fastboot command is required when using dualboot.
+  + If everything goes well and boot image was backed up. You can flash boot image into disk now. Then no fastboot command is required when using dualboot.
   + Flash boot:
   ```powershell
   fastboot flash boot new-boot.img
   ```
 - Recover original boot image:
-  + If you want to remove dualboot, flash your backuped boot image.
+- If you want to remove dualboot, flash your backed up boot image.
   ```powershell
   fastboot flash boot.img
   ```

DualBoot/ShellCode.md

@@ -7,17 +7,17 @@ Shell Code is the key place why we patch kernel or what do we patch kernel for.
 ## DualBoot ShellCodes
 - For DualBoot feature, here provided several sources:
   + [DummyHead.S](https://github.com/Project-Aloha/DualBootKernelPatcher/blob/main/ShellCode/DummyHead.S)
-    - PlaceHolders of Linux Kernel hdr.(refer `kernel64_hdr` struct in [Qualcomm ABL](https://git.codelinaro.org/clo/la/abl/tianocore/edk2/-/blob/KERNEL.PLATFORM.2.1.r1-04700-kernel.0/QcomModulePkg/Include/Library/BootImage.h?ref_type=tags#L477-489))
+    - Placeholders of Linux Kernel hdr.(refer `kernel64_hdr` struct in [Qualcomm ABL](https://git.codelinaro.org/clo/la/abl/tianocore/edk2/-/blob/KERNEL.PLATFORM.2.1.r1-04700-kernel.0/QcomModulePkg/Include/Library/BootImage.h?ref_type=tags#L477-489))
     - This part will not be injected into Linux kernel.
 
   + `ShellCode.xxx.S`
     - Read flags in memory or do other check.
     - Once the conditions are met, will jump to `_UEFI`, otherwise continue next instruction.
 
   + [CommonTail.S](https://github.com/Project-Aloha/DualBootKernelPatcher/blob/main/ShellCode/CommonTail.S)
-    - First instruction is jumping to linux, that happen when condition in `ShellCode.xxx.S` not meet.
-    - Provide `_UEFI`label, `ShellCode.xxx.S` will jump here after conditions.
-    - Handles unexceptional behavior in the end.
+    - First instruction is jumping to linux, that happens when the condition in `ShellCode.xxx.S` is not met.
+    - Provide `_UEFI` label, `ShellCode.xxx.S` will jump here after conditions.
+    - Handles unexpected behavior in the end.
 
 ## DTB Wrapper
   - Coming soon.