Просмотр исходного кода

docs: dedupe project docs (pass A — keep 6 pages distinct)

- kernelflasher/magiskboot: remove duplicate CAUTION, Match-version NOTE, WARNING and Related footer; link to installation.md for prerequisites/risks; shorten steps
- kernelflasher: drop duplicate Troubleshooting (canonical in post-install)
- post-install: streamline checklists, remove Related footer
- supported-devices: drop 4 empty vendor placeholders (OPPO/Realme/Xiaomi/Nothing), keep Pixel/Samsung/OnePlus/Other
- README: TIP now links only to features (Supported Devices has dedicated section)
TheWildJames 1 неделя назад
Родитель
Сommit
409e0252e9
5 измененных файлов с 43 добавлено и 137 удалено
  1. 1 1
      README.md
  2. 9 33
      docs/kernelflasher.md
  3. 21 59
      docs/magiskboot.md
  4. 12 20
      docs/post-install.md
  5. 0 24
      docs/supported-devices.md

+ 1 - 1
README.md

@@ -45,7 +45,7 @@ Generic kernels built on [Google's GKI sources](https://android.googlesource.com
 - **DroidSpaces** — container runtime
 
 > [!TIP]
-> Full documentation: [docs/features.md](docs/features.md) · [Supported Devices](docs/supported-devices.md)
+> Full documentation: [docs/features.md](docs/features.md)
 
 ---
 

+ 9 - 33
docs/kernelflasher.md

@@ -1,28 +1,21 @@
 # Install with Kernel Flasher
 
 > [!NOTE]
-> This method is more convenient when upgrading KernelSU and can be done without a computer. Make a backup first.
+> This method is more convenient when upgrading KernelSU and can be done without a computer.
 
-> [!CAUTION]
-> Wild Kernels is not responsible for bricked devices or damage. By flashing, you assume all risk. Back up your data and understand the risks before flashing.
+See [Installation](installation.md) for prerequisites, supported versions, and risks.
 
 ## Prerequisites
 
-- [ ] Device with unlocked bootloader running a GKI2 kernel 5.10+
-- [ ] Root access already granted to the flashing app
+- Root access already granted to the flashing app (for first install from stock without root, use recovery/fastboot — see [magiskboot](magiskboot.md))
+- AnyKernel3 ZIP matching your kernel version from [Releases](https://github.com/WildKernels/GKI_KernelSU_SUSFS/releases)
 
 ## Steps
 
-1. **Download the AnyKernel3 ZIP** that matches your kernel version (e.g., `6.1.x-androidXX`) from the latest [Releases](https://github.com/WildKernels/GKI_KernelSU_SUSFS/releases) page.
-2. **Open the Kernel Flasher app**, grant necessary root permissions when prompted.
-3. **Select the AnyKernel3 ZIP** you downloaded and flash. Do not interrupt the process.
-4. **Reboot** when prompted and verify KernelSU manager shows the expected version.
-
-> [!NOTE]
-> Match by the full kernel version (e.g., `6.1.x-androidXX`) — your device's Android version and the `androidXX` in the kernel version are not necessarily the same. For example, as of writing, a Google Pixel 8 is on `6.1.157-android14` while the system Android is 17.
-
-> [!TIP]
-> This requires the flashing app to have root permissions. On first install from stock (no root yet), flash via recovery or fastboot instead, then use this method for subsequent upgrades.
+1. **Download the AnyKernel3 ZIP** from the latest [Releases](https://github.com/WildKernels/GKI_KernelSU_SUSFS/releases) page.
+2. **Open the Kernel Flasher app**, grant root permissions when prompted.
+3. **Select the AnyKernel3 ZIP** and flash. Do not interrupt.
+4. **Reboot** when prompted and verify the manager shows the expected version.
 
 ## Supported flashing apps
 
@@ -30,23 +23,6 @@
 |-----|-------|
 | [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher) | Recommended, actively maintained |
 
-> [!WARNING]
-> Requires root to flash a kernel from within Android.
-
 ## After flashing
 
-See [Post-Install — Verify & Finish Setup](post-install.md) for manager install, SUSFS module, and verification.
-
-## Troubleshooting
-
-<details>
-<summary>Common issues</summary>
-
-- **Bootloop** — restore a stock boot.img via fastboot/recovery.
-- **Manager and kernel version do not match (e.g. 31000 != 32000)** — for best compatibility ensure both match. Install the latest kernel and manager linked in the release and reboot fully.
-
-</details>
-
----
-
-Related: [Installation Overview](installation.md) · [Patch boot.img Manually](magiskboot.md)
+See [Post-Install — Verify & Finish Setup](post-install.md).

+ 21 - 59
docs/magiskboot.md

@@ -1,21 +1,17 @@
 # Patch boot.img Manually (magiskboot)
 
-> [!CAUTION]
-> Wild Kernels is not responsible for bricked devices or damage. By flashing, you assume all risk. Back up your data and understand the risks before flashing.
-
 > [!TIP]
-> It's always recommended to use `magiskboot` to patch images — use the [official build](https://github.com/topjohnwu/Magisk/releases), which runs on Android devices and Linux.
+> Use the [official magiskboot build](https://github.com/topjohnwu/Magisk/releases) — works on Android and Linux.
+
+See [Installation](installation.md) for prerequisites, supported versions, and risks.
 
 **Platforms:** [Android](#-android) · [Linux](#-linux)
 
 ## Preparation
 
 1. Get your device's stock `boot.img`.
-2. Download the AnyKernel3 ZIP file that matches your kernel version (e.g., `6.1.x-androidXX`).
-3. Unpack the AnyKernel3 package and get the `Image` file, which is the kernel file of KernelSU.
-
-> [!NOTE]
-> Match by the full kernel version (e.g., `6.1.x-androidXX`) — your device's Android version and the `androidXX` in the kernel version are not necessarily the same. For example, as of writing, a Google Pixel 8 is on `6.1.157-android14` while the system Android is 17.
+2. Download the AnyKernel3 ZIP for your kernel version from [Releases](https://github.com/WildKernels/GKI_KernelSU_SUSFS/releases).
+3. Unpack the ZIP and get the `Image` file (the KernelSU kernel).
 
 ---
 
@@ -32,44 +28,36 @@ Folder structure on device (`/data/local/tmp/`):
 ```
 
 1. Download latest Magisk from [GitHub Releases](https://github.com/topjohnwu/Magisk/releases).
-2. Rename `Magisk-*(version).apk` to `Magisk-*.zip` and unzip it.
-3. Push `libmagiskboot.so` to your device by ADB:
+2. Rename `Magisk-*(version).apk` to `Magisk-*.zip` and unzip.
+3. Push `libmagiskboot.so` to device:
   ```sh
   adb push Magisk-*/lib/arm64-v8a/libmagiskboot.so /data/local/tmp/magiskboot
   ```
-4. Push stock `boot.img` and `Image` from AnyKernel3 to your device:
+4. Push `boot.img` and `Image`:
   ```sh
   adb push boot.img /data/local/tmp/
   adb push Image /data/local/tmp/
   ```
-5. Enter ADB shell and make it executable:
+5. Make executable:
   ```sh
   adb shell
   cd /data/local/tmp/
   chmod +x magiskboot
   ```
-6. Unpack `boot.img`:
+6. Unpack:
   ```sh
   ./magiskboot unpack boot.img
   ```
-  You will get a `kernel` file — this is your stock kernel.
-
-7. Replace the kernel with the KernelSU `Image`:
+7. Replace kernel:
   ```sh
   mv -f Image kernel
   ```
-8. Repack the boot image:
+8. Repack:
   ```sh
   ./magiskboot repack boot.img
   ```
-  You will get a `new-boot.img` file.
-
-9. To temporarily test you can run `fastboot boot new-boot.img`.
-
-10. Flash it by fastboot:
-  ```sh
-  fastboot flash boot new-boot.img
-  ```
+9. Test: `fastboot boot new-boot.img`
+10. Flash: `fastboot flash boot new-boot.img`
 
 </details>
 
@@ -85,38 +73,12 @@ Folder structure on PC:
 └── Image
 ```
 
-Official `magiskboot` can run in Linux normally — use the [official build](https://github.com/topjohnwu/Magisk/releases).
-
-1. Prepare stock `boot.img` and `Image` in your PC.
-2. Make it executable:
-  ```sh
-  chmod +x magiskboot
-  ```
-3. Unpack `boot.img`:
-  ```sh
-  ./magiskboot unpack boot.img
-  ```
-  You will get a `kernel` file — this is your stock kernel.
-
-4. Replace the kernel:
-  ```sh
-  mv -f Image kernel
-  ```
-5. Repack:
-  ```sh
-  ./magiskboot repack boot.img
-  ```
-  You will get a `new-boot.img` file.
-
-6. To temporarily test you can run `fastboot boot new-boot.img`.
-
-7. Flash it by fastboot:
-  ```sh
-  fastboot flash boot new-boot.img
-  ```
+1. Prepare `boot.img` and `Image` on PC.
+2. Make executable: `chmod +x magiskboot`
+3. Unpack: `./magiskboot unpack boot.img`
+4. Replace: `mv -f Image kernel`
+5. Repack: `./magiskboot repack boot.img`
+6. Test: `fastboot boot new-boot.img`
+7. Flash: `fastboot flash boot new-boot.img`
 
 </details>
-
----
-
-Related: [Installation Overview](installation.md) · [Install with Kernel Flasher](kernelflasher.md)

+ 12 - 20
docs/post-install.md

@@ -1,35 +1,31 @@
 # Post-Install — Verify & Finish Setup
 
-After flashing a Wild Kernels GKI kernel, do these checks to make sure everything is working.
-
-> [!TIP]
-> Follow in order — each step depends on the previous one.
+After flashing a Wild Kernels GKI kernel, do these checks in order.
 
 ## 1. Download matching manager — KernelSU / KernelSU-Next / ReSukiSU
 
 - [ ] Download the `manager-apk-*` from the same [Releases](https://github.com/WildKernels/GKI_KernelSU_SUSFS/releases) page you got the kernel from.
 - [ ] Install / update it over any existing manager.
-- [ ] Open the manager — it should show the kernel version you just flashed (e.g. `6.1.x-androidXX-Wild`).
-- [ ] Verify it reports "Working" / shows the correct version.
+- [ ] Open the manager — it should show the kernel version you just flashed (e.g. `6.1.x-androidXX-Wild`) and report "Working".
 
 ## 2. SUSFS
 
-- [ ] In the manager, install the [sidex15/susfs4ksu-module](https://github.com/sidex15/susfs4ksu-module) (recommended module for SUSFS).
-- [ ] Reboot after installing the module.
+- [ ] In the manager, install the [sidex15/susfs4ksu-module](https://github.com/sidex15/susfs4ksu-module).
+- [ ] Reboot.
 
 ## 3. Meta Module (if mounting modules)
 
-If you need to mount modules, install one of:
+If you need to mount modules, install one:
 
-- [ ] [NoMount](https://github.com/maxsteeel/nomount) (Recommended) — Download the `NoMount-metamodule-*commit*.zip` from the same [Releases](https://github.com/WildKernels/GKI_KernelSU_SUSFS/releases) page you got the kernel from
-- [ ] [Mountify](https://github.com/backslashxx/mountify) — you can always use the latest module if compatible with SUSFS used at time of Release
+- [ ] [NoMount](https://github.com/maxsteeel/nomount) (Recommended) — `NoMount-metamodule-*commit*.zip` from [Releases](https://github.com/WildKernels/GKI_KernelSU_SUSFS/releases)
+- [ ] [Mountify](https://github.com/backslashxx/mountify) — latest compatible module
 
 > [!NOTE]
-> Only one is required if mounting modules. Compatibility with SUSFS shifts due to constant changes and it is not always compatible.
+> Only one is required. Compatibility with SUSFS shifts with updates.
 
 ## 4. DroidSpaces
 
-- [ ] Download the app here: [ravindu644/Droidspaces-OSS](https://github.com/ravindu644/Droidspaces-OSS)
+- [ ] Download the app: [ravindu644/Droidspaces-OSS](https://github.com/ravindu644/Droidspaces-OSS)
 
 ## 5. Troubleshooting
 
@@ -38,21 +34,17 @@ If you need to mount modules, install one of:
 
 - **General issues** — try restarting your device.
 - **Bootloop** — restore a stock boot.img via fastboot/recovery.
-- **Manager and kernel version do not match (e.g. 31000 != 32000)** — for best compatibility ensure both match. Install the latest kernel and manager linked in the release and reboot fully.
-- **Root not working** — ensure you installed the manager matching the flashed flavor (KernelSU / KernelSU-Next / ReSukiSU).
+- **Manager and kernel version do not match (e.g. 31000 != 32000)** — install the latest kernel and manager from the release and reboot.
+- **Root not working** — ensure the manager matches the flashed flavor (KernelSU / KernelSU-Next / ReSukiSU).
 
 </details>
 
 <details>
 <summary><b> Nuclear option</b></summary>
 
-Uninstall all modules and reboot, then delete all files and folders in the `/data/adb` folder. Reboot again and confirm no leftover files remain.
+Uninstall all modules and reboot, then delete all files and folders in `/data/adb`. Reboot again.
 
 > [!CAUTION]
 > This wipes all KernelSU/Magisk module data — only use if nothing else works.
 
 </details>
-
----
-
-Related: [Installation Overview](installation.md) · [Install with Kernel Flasher](kernelflasher.md) · [Patch boot.img Manually](magiskboot.md)

+ 0 - 24
docs/supported-devices.md

@@ -50,30 +50,6 @@
 |--------|----------|------------|----------|--------|
 | — | — | — | — | Placeholder — add entries |
 
-## OPPO
-
-| Device | Codename | GKI Kernel | Firmware | Status |
-|--------|----------|------------|----------|--------|
-| — | — | — | — | Placeholder — add entries |
-
-## Realme
-
-| Device | Codename | GKI Kernel | Firmware | Status |
-|--------|----------|------------|----------|--------|
-| — | — | — | — | Placeholder — add entries |
-
-## Xiaomi / POCO / Redmi
-
-| Device | Codename | GKI Kernel | Firmware | Status |
-|--------|----------|------------|----------|--------|
-| — | — | — | — | Placeholder — add entries |
-
-## Nothing
-
-| Device | Codename | GKI Kernel | Firmware | Status |
-|--------|----------|------------|----------|--------|
-| — | — | — | — | Placeholder — add entries |
-
 ## Other
 
 | Device | Codename | GKI Kernel | Firmware | Status |