Cleanup of docs

.github/workflows/docs.yml

@@ -1,20 +0,0 @@
-name: Build Docs 
-on:
-  push:
-    branches: 
-      - main
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout main
-        uses: actions/checkout@v2
-
-      - name: Deploy docs
-        uses: mhausenblas/mkdocs-deploy-gh-pages@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CONFIG_FILE: ./mkdocs.yml
-          EXTRA_PACKAGES: build-base 

.github/workflows/documentation.yml

@@ -0,0 +1,17 @@
+name: Build & Deploy MkDocs
+on:
+  push:
+    branches:
+      - main
+    workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

docs/BIOS.md

@@ -1,153 +0,0 @@
-# BIOS
-
-## Vanilla BIOS Settings
-
-At the minimum, these BIOS settings must be made to install and run macOS without any problems:
-
-``` mermaid
-graph LR
-    id1[Main Menu]-->Security;
-    id1-->Config;
-    id1-->Startup;
-    Security-->TPM[Security Chip];
-    Security-->Fingerprint;
-    Security-->SBC[Secure Boot Configuration];
-    Config-->Network;
-    Startup-->|UEFI/Legacy Boot|id4[UEFI Only];
-    Startup-->|CSM Support|No;
-    TPM-->|Security Chip|id2[Disabled];
-    Fingerprint-->|Predesktop Authentication|id2;
-    SBC-->|Secure Boot|id2;
-    Network-->|Wake on LAN|id3[Disabled];
-    Network-->|Wake on LAN from Dock|id3;
-    Network-->|UEFI IPv4 Network Stack|id3;
-    Network-->|UEFI IPv6 Network Stack|id3;
-```
-
-!!! Tip
-    You can also disable hardware/features you do not need to save power, some examples are:
-
-``` mermaid
-graph LR
-    id1[Main Menu]-->Security;
-    id1-->Config;
-    Security-->id2[I/O Port Access];
-    Config-->USB;
-    id2-->|Wireless WAN|id3[Disabled];
-    id2-->|Fingerprint Reader|id3;
-    id2-->|Memory Card Slot|id3;
-    USB-->|Always on USB|Disabled;
-```
-
-* If you **DO NOT use Thunderbolt 3 hotplug** in macOS (don't mind shutting down the machine to connect TB3 devices), this will drastically lower power consumption:
-
-``` mermaid
-graph LR
-    id1[Main Menu]-->Config;
-    Config-->id2[Thunderbolt 3];
-    id2-->|Thunderbolt BIOS Assist Mode|Enabled;
-    id2-->|Thunderbolt Device|Enabled;
-```
-
-* If you **DO use Thunderbolt 3 hotplug in macOS** (at the expense of idle power consumption):
-
-``` mermaid
-graph LR
-    id1[Main Menu]-->Config;
-    Config-->id2[Thunderbolt 3];
-    id2-->|Thunderbolt BIOS Assist Mode|Disabled;
-    id2-->|Security Level|id3[No Security];
-    id2-->|Support in Pre Boot Environment: Thunderbolt Device|Disabled;
-```
-
-## Modding the BIOS
-
-!!! Danger
-    As of of July 16th, 2021: the BIOS mod will break TPM. Hence, Windows 11 will not work. Consider this if you wish to proceed.  
-
-A modded BIOS will allow for more optimizations to be made for macOS and will overall make your hackintosh better. I am a BIOS modding novice myself, but with these instructions, I was able to mod my x1c6 BIOS in less than one hour. I fully recommend doing this for all who think themselves capable. Furthermore, the default `config.plist` for this repository is meant to accommodate a modded BIOS with appropriate settings. If you cannot mod your BIOS or is unwilling to do so, use `config_unmoddedBIOS.plist`.
-
-<img align="center" src="https://raw.githubusercontent.com/tylernguyen/x1c6-hackintosh/main/docs/assets/CH341a.png" alt="CH341a" width="250">
-[SPI Programmer CH341a and SOIC8 connector](https://www.amazon.com/Organizer-Socket-Adpter-Programmer-CH341A/dp/B07R5LPTYM) are needed.
-
-Here are the steps to mod your BIOS (credits to `paranoidbashthot` and `\x`). Attempt this at your own risk.
-
-1. Refer to [digmorepaka/thinkpad-firnware-patches](https://github.com/digmorepaka/thinkpad-firmware-patches).
-2. Use `xx_80_patches-v*.txt`, I commented out WWAN patches since I do not need it.
-3. [@notthebee](https://github.com/notthebee) also has a useful video to follow: https://www.youtube.com/watch?v=ce7kqUEccUM
-4. Remember to **dump the vanilla twice and use `diff` to make sure things were dumped properly**, store this backup somewhere safe.
-5. Confirmed working `BIOS-v1.45`, I cannot be sure about other BIOS versions. Though they will most likely work as well.
-6. The modded BIOS does not need to be signed by `thinkpad-eufi-sign`. Just **remember to replace 4C 4E 56 42 42 53 45 43 FB with 4C 4E 56 42 42 53 45 43 FF on the patched BIOS.**
-   - The BIOS chip is located above the CPU, under the sticker shield:   
-
-<p align="center">
-<img src="https://user-images.githubusercontent.com/3349081/87883762-38686380-c9cf-11ea-9e9d-c400f7b5407b.jpg" alt="BIOS Chip" width="300">
-</p>
-
-7. Your BIOS chip may not be made by Winbond, but by Macronix instead. In that case, add the argument `-c MX25L12835F/MX25L12845E/MX25L12865E` to `flashrom`. See [Issue #116](https://github.com/tylernguyen/x1c6-hackintosh/issues/116#issuecomment-778654320)
-   - Successfully modding your BIOS will reveal the `Advance Menu` tab.
-
-<p align="center">   
-<img align="center" src="https://user-images.githubusercontent.com/3349081/87883767-3d2d1780-c9cf-11ea-9fb0-f250590a3f28.jpg" alt="BIOS Advance Menu" width="300"> 
-</p>
-
-8. It goes without saying, after doing this, do not update your BIOS unless you want to do this again.
-
-## Modded BIOS Settings
-The following are further optimization settings that can be figured once your BIOS is modded.
-
-* These settings are universally recommended optimizations for your hackintosh:
-
-``` mermaid
-graph TD
-    id1[Advance Tab]-->id2[Intel Advanced Menu];
-    id2-->id3[System Agent Configuration];
-    id2-->id4[Power & Performance];
-    id3-->id5[Graphics Configuration];
-    id4-->id6[CPU - Power Management Control];
-    id5-->|DVMT Pre-Allocated|64M;
-    id6-->id7[CPU Lock Configuration];
-    id7-->|CFG Lock|Disabled;
-```
-
-* I also recommend undervolting your machine regarless of your usage, the following are stable settings for my x1c6 with `i7-8650U`, verified by stress testing with `Prime95` and `Heaven Benchmark`, your may be worse or better, please do your own testing. In addition, I suggest you repaste your machine with an aftermarket thermal paste for lower temps and a better undervolt.
-
-``` mermaid
-graph TD
-    id1[Advance Tab]-->id2[Intel Advanced Menu];
-    id2-->id3[OverClocking Performance Menu];
-    id3-->|OverClocking Feature|Enabled;
-    id3-->Processor;
-    id3-->GT;
-    id3-->Uncore;
-    Processor-->|Voltage Offset|100;
-    Processor-->|Offset Prefix|id4[-];
-    GT-->|GT Voltage Offset|id8[80];
-    GT-->|Offset Prefix|id5[-];
-    GT-->|GTU Voltage Offset|id8;
-    GT-->|Offset Prefix|id5;
-    Uncore-->|Uncore Voltage Offset|80;
-    Uncore-->|Offset Prefix|id6[-];
-```
-
-* The following settings depend on your own personal preference:
-
- * If you want to optimize CPU **performance** at the cost of battery:
-
-``` mermaid
-graph LR
-    id1[Advance Tab]-->id2[Power & Performance];
-    id2-->id3[CPU - Power Management Control];
-    id3-->|Boot Performance Mode|id4[Turbo Performance];
-    id3-->|Config TDP Configurations|Up;
-```
-
- * If you want to optimize **battery time** at the cost of performance:
-
-``` mermaid
-graph LR
-    id1[Advance Tab]-->id2[Power & Performance];
-    id2-->id3[CPU - Power Management Control];
-    id3-->|Boot Performance Mode|id4[Max Battery];
-    id3-->|Config TDP Configurations|Down;
-```

docs/BIOS/modding-the-BIOS.md

@@ -0,0 +1,30 @@
+!!! Danger
+    As of of July 16th, 2021: the BIOS mod will break TPM. Hence, Windows 11 will not work. Consider this if you wish to proceed.  
+
+A modded BIOS will allow for more optimizations to be made for macOS and will overall make your hackintosh better. I am a BIOS modding novice myself, but with these instructions, I was able to mod my x1c6 BIOS in less than one hour. I fully recommend doing this for all who think themselves capable. Furthermore, the default `config.plist` for this repository is meant to accommodate a modded BIOS with appropriate settings. If you cannot mod your BIOS or is unwilling to do so, use `config_unmoddedBIOS.plist`.
+
+<img align="center" src="https://raw.githubusercontent.com/tylernguyen/x1c6-hackintosh/main/docs/assets/CH341a.png" alt="CH341a" width="250">
+[SPI Programmer CH341a and SOIC8 connector](https://www.amazon.com/Organizer-Socket-Adpter-Programmer-CH341A/dp/B07R5LPTYM) are needed.
+
+Here are the steps to mod your BIOS (credits to `paranoidbashthot` and `\x`). Attempt this at your own risk.
+
+1. Refer to [digmorepaka/thinkpad-firnware-patches](https://github.com/digmorepaka/thinkpad-firmware-patches).
+2. Use `xx_80_patches-v*.txt`, I commented out WWAN patches since I do not need it.
+3. [@notthebee](https://github.com/notthebee) also has a useful video to follow: https://www.youtube.com/watch?v=ce7kqUEccUM
+4. Remember to **dump the vanilla twice and use `diff` to make sure things were dumped properly**, store this backup somewhere safe.
+5. Confirmed working `BIOS-v1.45`, I cannot be sure about other BIOS versions. Though they will most likely work as well.
+6. The modded BIOS does not need to be signed by `thinkpad-eufi-sign`. Just **remember to replace 4C 4E 56 42 42 53 45 43 FB with 4C 4E 56 42 42 53 45 43 FF on the patched BIOS.**
+   - The BIOS chip is located above the CPU, under the sticker shield:   
+
+<p align="center">
+<img src="https://user-images.githubusercontent.com/3349081/87883762-38686380-c9cf-11ea-9e9d-c400f7b5407b.jpg" alt="BIOS Chip" width="300">
+</p>
+
+7. Your BIOS chip may not be made by Winbond, but by Macronix instead. In that case, add the argument `-c MX25L12835F/MX25L12845E/MX25L12865E` to `flashrom`. See [Issue #116](https://github.com/tylernguyen/x1c6-hackintosh/issues/116#issuecomment-778654320)
+   - Successfully modding your BIOS will reveal the `Advance Menu` tab.
+
+<p align="center">   
+<img align="center" src="https://user-images.githubusercontent.com/3349081/87883767-3d2d1780-c9cf-11ea-9fb0-f250590a3f28.jpg" alt="BIOS Advance Menu" width="300"> 
+</p>
+
+8. It goes without saying, after doing this, do not update your BIOS unless you want to do this again.

docs/BIOS/settings-for-modded-BIOS.md

@@ -0,0 +1,57 @@
+The following are further optimization settings that can be figured once your BIOS is modded.
+
+* These settings are universally recommended optimizations for your hackintosh:
+
+``` mermaid
+graph TD
+    id1[Advance Tab]-->id2[Intel Advanced Menu];
+    id2-->id3[System Agent Configuration];
+    id2-->id4[Power & Performance];
+    id3-->id5[Graphics Configuration];
+    id4-->id6[CPU - Power Management Control];
+    id5-->|DVMT Pre-Allocated|64M;
+    id6-->id7[CPU Lock Configuration];
+    id7-->|CFG Lock|Disabled;
+```
+
+* I also recommend undervolting your machine regarless of your usage, the following are stable settings for my x1c6 with `i7-8650U`, verified by stress testing with `Prime95` and `Heaven Benchmark`, your may be worse or better, please do your own testing. In addition, I suggest you repaste your machine with an aftermarket thermal paste for lower temps and a better undervolt.
+
+``` mermaid
+graph TD
+    id1[Advance Tab]-->id2[Intel Advanced Menu];
+    id2-->id3[OverClocking Performance Menu];
+    id3-->|OverClocking Feature|Enabled;
+    id3-->Processor;
+    id3-->GT;
+    id3-->Uncore;
+    Processor-->|Voltage Offset|100;
+    Processor-->|Offset Prefix|id4[-];
+    GT-->|GT Voltage Offset|id8[80];
+    GT-->|Offset Prefix|id5[-];
+    GT-->|GTU Voltage Offset|id8;
+    GT-->|Offset Prefix|id5;
+    Uncore-->|Uncore Voltage Offset|80;
+    Uncore-->|Offset Prefix|id6[-];
+```
+
+* The following settings depend on your own personal preference:
+
+ * If you want to optimize CPU **performance** at the cost of battery:
+
+``` mermaid
+graph LR
+    id1[Advance Tab]-->id2[Power & Performance];
+    id2-->id3[CPU - Power Management Control];
+    id3-->|Boot Performance Mode|id4[Turbo Performance];
+    id3-->|Config TDP Configurations|Up;
+```
+
+ * If you want to optimize **battery time** at the cost of performance:
+
+``` mermaid
+graph LR
+    id1[Advance Tab]-->id2[Power & Performance];
+    id2-->id3[CPU - Power Management Control];
+    id3-->|Boot Performance Mode|id4[Max Battery];
+    id3-->|Config TDP Configurations|Down;
+```

docs/BIOS/settings-for-vanilla-BIOS.md

@@ -0,0 +1,59 @@
+## Vanilla BIOS Settings
+
+At the minimum, these BIOS settings must be made to install and run macOS without any problems:
+
+``` mermaid
+graph LR
+    id1[Main Menu]-->Security;
+    id1-->Config;
+    id1-->Startup;
+    Security-->TPM[Security Chip];
+    Security-->Fingerprint;
+    Security-->SBC[Secure Boot Configuration];
+    Config-->Network;
+    Startup-->|UEFI/Legacy Boot|id4[UEFI Only];
+    Startup-->|CSM Support|No;
+    TPM-->|Security Chip|id2[Disabled];
+    Fingerprint-->|Predesktop Authentication|id2;
+    SBC-->|Secure Boot|id2;
+    Network-->|Wake on LAN|id3[Disabled];
+    Network-->|Wake on LAN from Dock|id3;
+    Network-->|UEFI IPv4 Network Stack|id3;
+    Network-->|UEFI IPv6 Network Stack|id3;
+```
+
+!!! Tip
+    You can also disable hardware/features you do not need to save power, some examples are:
+
+``` mermaid
+graph LR
+    id1[Main Menu]-->Security;
+    id1-->Config;
+    Security-->id2[I/O Port Access];
+    Config-->USB;
+    id2-->|Wireless WAN|id3[Disabled];
+    id2-->|Fingerprint Reader|id3;
+    id2-->|Memory Card Slot|id3;
+    USB-->|Always on USB|Disabled;
+```
+
+* If you **DO NOT use Thunderbolt 3 hotplug** in macOS (don't mind shutting down the machine to connect TB3 devices), this will drastically lower power consumption:
+
+``` mermaid
+graph LR
+    id1[Main Menu]-->Config;
+    Config-->id2[Thunderbolt 3];
+    id2-->|Thunderbolt BIOS Assist Mode|Enabled;
+    id2-->|Thunderbolt Device|Enabled;
+```
+
+* If you **DO use Thunderbolt 3 hotplug in macOS** (at the expense of idle power consumption):
+
+``` mermaid
+graph LR
+    id1[Main Menu]-->Config;
+    Config-->id2[Thunderbolt 3];
+    id2-->|Thunderbolt BIOS Assist Mode|Disabled;
+    id2-->|Security Level|id3[No Security];
+    id2-->|Support in Pre Boot Environment: Thunderbolt Device|Disabled;
+```

docs/Getting-Started.md

@@ -1,32 +0,0 @@
-# Getting Started
-
-# Creating the macOS Installer
-
-Please refer to [Dortania's Creating the USB](https://dortania.github.io/OpenCore-Install-Guide/installer-guide/).
-
-!!! tip
-    Often as above, the project will defer universal steps to Dortania links. Hence, this repository is meant to be used in conjunction with their guides.  
-
-# Using the Respository
-
-1. Once the macOS installer has been created, copy `EFI` inside onto the installer's EFI partitition and make the following changes to `config.plist`
-    
-    - `ShowPicker` to `YES`
-    - Add `-v` to `boot-args`
-    - If your machine has a vanilla (unmodded) BIOS, merge `/patches/ OpenCore Patches/ Vanilla BIOS.plist` with `config.plist`
-
-!!! note
-    It is generally a good idea to keep the install drive with OpenCore around. As you tweak your own `opencore.plist`, things may break and you will not be able to get back into macOS using the system's OpenCore. In those times, you can use the install drive to boot into macOS.
-
-2. Once macOS has been installed, boot the installed macOS paritition with the existing installer USB and complete new user setup.
-3. Copy `EFI` onto the macOS drive's EFI partition. Similar to before, you may wish to:
-
-    - Merge `/patches/ OpenCore Patches/ Vanilla BIOS.plist` with `config.plist` if you have an unmodded BIOS.
-
-!!! success
-    At this point, your machine should boot into macOS without anything attached.
-
-1. There are a few other things to review and add on before your Hackintosh can be complete. Please proceed to Post Installation.
-
-!!! tip
-    Actively refer to Summary to get an idea of each functioning parts.

docs/Hardware.md

@@ -1,55 +0,0 @@
-# Hardware
-
-## Storage
-
-!!! Warning
-    The factory PM981 NVMe drive does not play well with macOS.
-
-For installation on the factory drive `PM981`, please refer to [Issue #43](https://github.com/tylernguyen/x1c6-hackintosh/issues/43). I do, however, recommend against this. 
-
-
-!!! Note
-    Replace the PM981 with an aftermarket NVMe for a much smoother experience.
-
-Consult the [dortania/Anti-Hackintosh-Buyers-Guide](https://dortania.github.io/Anti-Hackintosh-Buyers-Guide/Storage.html) for up-to-date storage recommendations.
-
-!!! Tip
-    You can install an additional M.2 2242 NVMe drive in the WWAN card slot.
-
-This is very useful if you intend to also use Windows/Linux, as partitioning a single drive for dual booting can be troublesome.
-
-## WiFi and Bluetooth
-
-!!! Tip
-    If your laptop did not come with WWAN, you can purchase additional antennas to add to your laptop. This is useful when using WiFi/Bluetooth cards that have 3 antennas.
-
-- The laptop's default wireless card should work via the [OpenIntelWireless](https://github.com/OpenIntelWireless) kexts.
-- For a vanilla and native experience, you may wish to buy a BCM94360CS2 card, along with a M.2 NGFF adapter. 
-- For future proofing and the fastest wireless/bluetooth speed, I recommend the AX200 (the card I am using). This card will also require the various [OpenIntelWireless](https://github.com/OpenIntelWireless) kexts.
-
-!!! Note
-    See `patches/Network Patches/` for OpenCore patches for custom wireless cards.
-
-- You should also see [`dortania/Wireless-Buyers-Guide`](https://dortania.github.io/Wireless-Buyers-Guide/).  
-
-## Optimizations (Optional):
-
-- Repaste the machine with thermal [Grizzly Kryonaut](https://www.thermal-grizzly.com/en/products/16-kryonaut-en).
-- If you're experienced or would to try liquid metal, use [Grizzly Conductonaut](https://www.thermal-grizzly.com/produkte/25-conductonaut). Though I've found that in my expereience, [Grizzly Kryonaut](https://www.thermal-grizzly.com/en/products/16-kryonaut-en) is enough.
-- Replace your machine's fan (if applicable). See https://www.reddit.com/r/thinkpad/comments/c7zpah/x1_carbon_6th_gen_horrible_cooling_fan_design/
-- Mod the BIOS the unlock Intel Advance Menu. see [BIOS.md](https://tylernguyen.github.io/x1c6-hackintosh/BIOS/)
-
-## Differing Models
-
-- These are relevant components on my machine which may differ from yours, keep these in mind as you will need to adjust accordingly, depending on your machine's configuration.
-
-| Category  | Component                            | Remarks |
-| --------- | ------------------------------------ | ------------ |
-| CPU       | [i7-8650U](https://ark.intel.com/content/www/us/en/ark/products/124968/intel-core-i7-8650u-processor-8m-cache-up-to-4-20-ghz.html) | Generate your own `CPUFriendDataProvider.kext`. See `SUMMARY`
-| SSD       | Seagate Firecuda 520 500GB           | [Dortania's Anti Hackintosh Buyers Guide](https://dortania.github.io/Anti-Hackintosh-Buyers-Guide/Storage.html) 
-| Display   | 14.0" (355mm) HDR WQHD (2560x1440)   | `/patches/ Internal Displays/` and [Issue #60](https://github.com/tylernguyen/x1c6-hackintosh/issues/60)
-| WiFi & BT | BCM94360CS2                          | `/patches/ Network Patches/` if non-native.
-| WWAN      | None | Unless needed in other OSes, disable at BIOS to save power
-
-- Refer to [/docs/references/x1c6-Platform_Specifications](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/references/x1c6-Platform_Specifications.pdf) for possible stock ThinkPad X1 6th Gen configurations.
-

docs/Issues.md

@@ -1,4 +1,7 @@
-# Issues
+---
+hide:
+  - navigation
+---
 
 ## FAQ
 
@@ -6,6 +9,7 @@
     None of this applies to you if your machine is not an X1C6, or similar models such as the T480. You're on your own there.
 
 #### "My X isn't working!"
+
 - Was it supposed to work? Check Summary
 - Have you applied the needed patch? Check Summary, `/patches/Network Patches` and `/patches/Display Patches`.
 - Is it an acknowledged, won't be fixed issue? Check [Issues/ beyond my scope](https://github.com/tylernguyen/x1c6-hackintosh/issues?q=is%3Aissue+is%3Aclosed+label%3A%22beyond+my+scope+%28for+now%29%22).

docs/Post-Installation.md

@@ -1,71 +0,0 @@
-## Upgrading and other Major Changes
-
-- macOS minor version upgrade works just as any Mac would.
-- It is generally a good idea to hold off on new major macOS releases until kexts and other dependencies have been tested.
-- The macOS version of my machine is displayed on a badge in `README.md`
-
-## Configuring PlatformInfo for iMessage/iCloud/FaceTime
-
-- Refer to [dortania /OpenCore-Install-Guide](https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html)
-- NOTE: `We’re sorry, but this serial number isn’t valid` is fine and has personally worked and working for me and many others. `Purchase Date not Validated` can be a problem down the line if a legitimate machine with that PlatformInfo is activated.
-
-## Dual Booting
-
-- I recommend that you dual boot using another drive in the WAN slot (I have the WDC PC SN520 NVMe 2242). This makes installation much easier, and lets the BIOS F12 option act as your boot manager.
-- I've found that dual booting with OpenCore on a single can be quite troublesome. Instead, what I recommend is to use rEFInd Boot Manager should you need to dual boot Windows or Linux.
-- It is possible to share Bluetooth pairing keys between Windows and macOS when dual booting. 
-  - The `.reg` for Bluetooth connected devices in macOS can be exported using Hackintool's Utilities section. This key can then be imported to Windows.
-
-## Sleep
-
-- Disable Power Nap for both [`Battery`](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/assets/macOS%20Settings/Battery_powernap.png) and [`Power Adapter`](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/assets/macOS%20Settings/Poweradt_powernap.png).
-- Disable [`Wake for Network Access`](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/assets/macOS%20Settings/Poweradt_powernap.png) in `Power Adapter`.
-- Uncheck [`Allow Bluetooth devices to wake this computer`](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/assets/img/macOS%20Settings/Bluetooth_wake.png) if you do not need it.
-- Do not disable `hibernatefile`.
-- `sudo pmset -a tcpkeepalive 0` to disable Network while sleeping.
-- `sudo pmset -a proximitywake 0` to disable peripheral wake agent.
-
-## HiDPI, specfically, HiDPI for the WQHD-HDR 1440p Display
-
-- Run [xzhih/one-key-hidpi](https://github.com/xzhih/one-key-hidpi)
-
-## EDID Override
-
-- This is necessary to fix HDMI hotplug.
-- See current available patches in `/patches/Internal Displays/`, merge them with `config.plist`
-- If a patch is not yet created for your display model. Please see [Issue #60](https://github.com/tylernguyen/x1c6-hackintosh/issues/60) to create your own EDID override. Please create a pull request to add your EDID override for different displays.
-
-## Thunderbolt 3 Hotplug
-
-- Native-like integration with macOS in System Report without the need of flashing a modded firmware. Thank you @benbender
-- NOTE: If you do have a modded BIOS firmware, please reset all settings relating to Thunderbolt 3 to default, all that's needed are settings detailed below or in [1_README-HARDWAREandBIOS.md](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/1_README-HARDWAREandBIOS.md)  
-- Please make sure of these settings in BIOS:  
-
-| Main Menu | Sub 1       | Sub 2                                         | Sub 3                                                              |
-| --------- | ----------- | --------------------------------------------- | ------------------------------------------------------------------ |
-|           | >> Config   | >> Thunderbolt (TM) 3                         | Thunderbolt BIOS Assist Mode `Disabled`                            |
-|           |             |                                               | Security Level `No Security`                                       |
-|           |             |                                               | Support in Pre Boot Environment: Thunderbolt(TM) Device `Disabled` |
-
-- Note: USB 3.1 Gen2 hotplug still Work-in-progress.
-
-## Keyboard
-
-- PrtSc (remapped to F13) = I use it for Screen Capture (Set in `System Preferences/Keyboard/Shortcuts`)
-- Check `Use F1, F2, etc. keys as standard function keys` in `System Preferences/Keyboard` to gain access to standard F keys:  
-
-<p align="center">
-  <img src="https://raw.githubusercontent.com/tylernguyen/x1c6-hackintosh/main/docs/assets/macOS%20Settings/fnkeys.png" width="400">
-</p>
-
-- Additionally, [Karabiner-Elements](https://karabiner-elements.pqrs.org/) and [BetterTouchTool](https://folivora.ai/) are great productivty tools to remap and/or add functions to your keyboard.
-
-## Touchpad
-
-- Force Click is enabled by default, which turns any click on the trackpad into a force touch. I suggest you turn this off.
-- In addition, I prefer to have tap to click on:  
-
-<p align="center">
-  <img src="https://raw.githubusercontent.com/tylernguyen/x1c6-hackintosh/main/docs/assets/macOS%20Settings/touchpad.png" width="400">
-</p>
-

docs/Summary.md

@@ -1,64 +0,0 @@
-# Summary
-
-### Non-Fuctional:
-| Feature                              | Status | Dependency          | Remarks                      |
-| :----------------------------------- | ------ | ------------------- | ---------------------------- |
-| Fingerprint Reader   | ❌ | `DISABLED` in BIOS to save power if not used in other OSes.   | Linux support was only recently added    |
-| Wireless WAN         | ❌ | `DISABLED` in BIOS to save power if not used in other OSes.   | Unable to investigate as I have no need and my model did not come with WWAN. |
-| Load Apple's Graphics Micro Code (GuC) | ❌ | | See [Issue #103](https://github.com/tylernguyen/x1c6-hackintosh/issues/103). Will never work AFAIK due to inherent incompatibility. |
-
-### Video and Audio
-| Feature                              | Status | Dependency          | Remarks                      |
-| :----------------------------------- | ------ | ------------------- | ---------------------------- |
-| Full Graphics Accleration (QE/CI)    | ✅   | `WhateverGreen.kext`                   | -   |
-| Audio Recording                      | ✅   | `AppleALC.kext` with Layout ID = 21    | -   |
-| Audio Playback                       | ✅   | `AppleALC.kext` with Layout ID = 21    | -   |
-| Automatic Headphone Output Switching | ✅   | `AppleALC.kext` with Layout ID = 21    | -   |
-
-### Power, Charge, Sleep and Hibernation
-| Feature                              | Status | Dependency          | Remarks                      |
-| :----------------------------------- | ------ | ------------------- | ---------------------------- |
-| Battery Percentage Indication | ✅    | `SSDT-Battery.aml` and `/patches/OpenCore Patches/Battery.plist`             | 
-| CPU Power Management (SpeedShift)    | ✅      | `XCPM` and `CPUFriend.kext`, generate your own `CPUFriendDataProvider` with [CPUFriendFriend](https://github.com/corpnewt/CPUFriendFriend_) or [one-key-cpufriend](https://github.com/stevezhengshiqi/one-key-cpufriend). |
-| iGPU Power Management        | ✅ | `XCPM`, enabled by `SSDT-PM.aml`                   | 
-| NVMe Drive Battery Management | ✅     | `NVMeFix.kext`  | In my experience, NVMe drives will drain more power than SATA drives.           |
-| S3 Sleep/ Hibernation Mode 3 | ✅ | `SSDT-Sleep.aml` | |
-| Hibernation Mode 25          | ✅ | `RTCMemoryFixup.kext` and `HibernationFixup.kext`      | Supported, macOS uses mode 3 by default. Change to mode 25 via `pmset`.     |   
-| Custom Charge Threshold      | ✅ | `SSDT-EC.aml`, [YogaSMC.kext](https://github.com/zhen-zen/YogaSMC), and [YogaSMCPane](https://github.com/zhen-zen/YogaSMC)| Adjust with YogaSMCPane in System Preferences
-| Fan Control                  | ✅ | `SSDT-EC.aml`, [YogaSMC.kext](https://github.com/zhen-zen/YogaSMC), and [YogaSMCPane](https://github.com/zhen-zen/YogaSMC)| Adjust with YogaSMC App.
-| Battery Life                 | ✅ | Native, comparable to Windows/Linux. Biggest impact is TB3, see [docs/BIOS.md](https://tylernguyen.github.io/x1c6-hackintosh/BIOS/)   | Will need a modded BIOS to disable `CFG Lock`
-
-
-### Input/ Output
-| Feature                              | Status | Dependency          | Remarks                      |
-| :----------------------------------- | ------ | ------------------- | ---------------------------- |
-| WiFi                                       | ✅ | Native with `BCM94360CS2`, Intel `AX200` is preferred. | See `/patches/ Network Patches/` for patches.        |
-| Bluetooth                                  | ✅ | Native with `BCM94360CS2`. Intel `AX200` is preferred. | See `/patches/ Network Patches/` for patches.        |
-| Ethernet                                   | ✅ | `IntelMausi.kext` | Needs Lenovo Ethernet adapter: [Item page](https://www.lenovo.com/us/en/accessories-and-monitors/cables-and-adapters/adapters/CABLE-BO-Ethernet-Extension-Adapter-2/p/4X90Q84427) |
-| HDMI hotplug                               | ✅ | Custom EDID Override `/patches/Internal Displays/`                                                                  | Refer to [Issue #60](https://github.com/tylernguyen/x1c6-hackintosh/issues/60) if one does not exist already for your display. |
-| 4K UHD output via HDMI/ DisplayPort **(Modded BIOS)**  | ✅ | See `DMVT Pre-Allocated` to `64M`  | See [docs/BIOS.md](https://tylernguyen.github.io/x1c6-hackintosh/BIOS/) for information about modding the BIOS.           |
-| 4K UHD output via HDMI/ DisplayPort **(Vanilla BIOS)** | ✅ | See `/patches/OpenCore Patches/4K-Output-wo-BIOSmod.plist`     | -           |
-| USB 2.0, USB 3.0, and Micro SD Card Reader | ✅ | `SSDT-XHC1.aml`    | -     |
-| USB 3.1                                    | ⚠️ | `SSDT-TB-DSB2-XHC2.aml`    | Hotplug WIP     |
-| USB Power Properties in macOS              | ✅ | `SSDT-XHC1.aml`    | -     |
-| Thunderbolt 3 Hotplug                      | ✅ | `SSDT-TB-*`     | Native interface within System Report   |
-
-### Display, TrackPad, TrackPoint, and Keyboard
-| Feature                              | Status | Dependency          | Remarks                      |
-| :----------------------------------- | ------ | ------------------- | ---------------------------- |
-| Brightness Adjustments | ✅  | `WhateverGreen.kext`, `SSDT-PNLF.aml`, and `BrightnessKeys.kext`| |
-| HiDPI _(Optional)_     | ✅  | [xzhih/one-key-hidpi](https://github.com/xzhih/one-key-hidpi)   | Scaling issues post-sleep fixed with AAPL, ig-platform `BAAnWQ==`     |
-| TrackPoint             | ✅  | `VoodooPS2Controller.kext`                                      | -       |
-| TrackPad               | ✅  | `VoodooPS2Controller.kext` or `VoodooSMBus.kext` and `VoodooRMI.kext`     | `VoodooRMI.kext` is recommended and preferred over `VoodooPS2`. |
-| Built-in Keyboard      | ✅  | `VoodooPS2Controller.kext` | Optimizations recommended, see [`docs/Post-Installation.md`](https://tylernguyen.github.io/x1c6-hackintosh/Post-Installation/) |
-| Multimedia Keys        | ✅  | `BrightnessKeys.kext` and [YogaSMC](https://github.com/zhen-zen/YogaSMC) | `YogaSMC` is recommended and preferred over ThinkpadAssisstant  | 
-
-### macOS Continuity
-| Feature                              | Status | Dependency          | Remarks                      |
-| :----------------------------------- | ------ | ------------------- | ---------------------------- |
-| iCloud, iMessage, FaceTime | ✅ | Whitelisted Apple ID, Valid SMBIOS   | See [dortania /OpenCore-Install-Guide](https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html)  |
-| Continuty              | ✅     | Native with `BCM94360CS2`. `ExtendBTFeatureFlags` to `True` otherwise.       | See `/patches/Network Patches/` for specific network card.     |
-| AirDrop                | ✅     | Native with `BCM94360CS2`. `ExtendBTFeatureFlags` to `True` otherwise.       | See `/patches/Network Patches/` for specific network card.     |
-| Sidecar                | ✅     | Native with `BCM94360CS2`. `ExtendBTFeatureFlags` to `True` otherwise. iPad with >= `iPadOS 13`  | Tested with iPad Mini with iPadOS 13.1.2   |
-| FileVault              | ✅ | as configured in `config.plsit` per [Dortania's Post-Install](https://dortania.github.io/OpenCore-Post-Install/universal/security/filevault.html)|  |
-| Time Machine           | ✅     | Native | TimeMachine only backups your Macintosh partition. Manually backup your EFI partition using another method.  |

docs/config.plist.md

@@ -1,60 +0,0 @@
-# `config.plist`
-
-## Checking your OpenCore config.plist
-
-It is important to keep your OpenCore `config.plist` properly up-to-spec, as OpenCore configurations tend to change accordingly with OpenCore versions. A good resource to check your `config.plist` is the `ocvalidate` binary that is bundled with every OpenCore releases.
-
-## `config.plist` Comments:
-* There are two `plist` files. Default `config.plist` is meant who those with a modded BIOS and have made the approiate settings as detailed in [docs/1_README-HARDWAREandBIOS.md](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/1_README-HARDWAREandBIOS.md) while `config_unmoddedBIOS.plist` is meant for those without a modded BIOS. If you have a modded BIOS and have made the adjustments detailed in my docs, `config.plist` should suffice. If your BIOS is unmodded, simply add the contents of `config_unmoddedBIOS.plist` to the main `config.plist`.
-* Notes on kexts and ACPI patches are on the respective OpenCore entries. Additionally, notes on ACPI patches can be found in [docs/2_README-ACPIpatching.md](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/2_README-ACPIpatching.md) as well as comments inside the patch.
-* Audio patches:   
-`Device Properties` > `PciRoot(0x0)/Pci(0x1f,0x3)` > `layout-id`: Injects AppleALC layout-id `21`
-* Intel iGPU and HDMI patches:
-`Device Properties` > `PciRoot(0x0)/Pci(0x2,0x0)` >  
-    * `device-id` = `16590000` per [WhateverGreen/IntelHD.en.md](https://github.com/acidanthera/WhateverGreen/blob/main/Manual/FAQ.IntelHD.en.md)
-    * `AAPL,ig-platform-id` = This is negotiable. In the future, I will test different variables for optimization. For now, `04002759` works well enough. 
-    * `AAPL00,override-no-connect` = EDID override to fix HDMI hotplug. Search for yours at `patches/Internal Displays/` or see [Issue #60](https://github.com/tylernguyen/x1c6-hackintosh/issues/60) to create one for your display model.
-    * `framebuffer-con1-enable` to enable framebuffer patching by WEG on connector 1.
-    * `framebuffer-con1-type` to set connector 1 type to HDMI (per IOReg)
-    * `framebuffer-patch-enable` tells WEG to patch framebuffer.
-    * `AAPL00,override-no-connect` to override EDID (dependent on display models). See `patches/Internal Displays/`. This is necessary to fix HDMI hotplug. To create your own, see [Issue #60](https://github.com/tylernguyen/x1c6-hackintosh/issues/60)
-* FileVault compatibility:
-    * Misc -> Boot
-        * `PollAppleHotKeys` set to `YES`(While not needed can be helpful)
-    * Misc -> Security
-        * `AuthRestart` set to `YES`(Enables Authenticated restart for FileVault 2 so password is not required on reboot. Can be considered a security risk so optional)
-    * NVRAM -> Add -> 4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14
-        * `UIScale` set to `02` for high resolution small displays
-    * UEFI -> Input
-        * `KeySupport` set to `YES`(Only when using OpenCore's builtin input, users of OpenUsbKbDxe should avoid)
-    * UEFI -> Output
-        * `ProvideConsoleGop` to `YES`
-    * UEFI -> ProtocolOverrides
-        * `FirmwareVolume` set to `YES`
-        * `AppleSmcIo` set to `YES`(this replaces VirtualSMC.efi)
-    * UEFI -> Quirks
-        * `RequestBootVarRouting` set to `YES`
-* Hibernation Mode 25 support:
-    * Booter -> Quirks
-      * `DiscardHibernateMap` set to `YES`
-    * NVRAM -> Add -> 7C436110-AB2A-4BBB-A880-FE41995C9F82
-      * `boot-args` includes `-hbfx-dump-nvram rtcfx_exclude=80-AB`
-    * Misc -> Boot
-      * `HibernateMode` set to `NVRAM`
-    * UEFI -> ReservedMemory
-      * Address: `569344`
-      * Size: `4096`
-      * Type: `RuntimeCode`
-* Personalization:
-    * `ShowPicker` is `No`. Use `Esc` during boot to show picker when needed.
-    * `PickerMode` is `External` to use `OpenCanopy` boot menu. If you prefer a lighter `EFI`, delete `Resources` and switch variable to `Builtin`.
-    * `PlayChime` is `No`. Set this to `Yes` if you want the native chime to play upon boot.
- 
-* OpenCanopy Support:  
-I prefer OpenCanopy for its looks. However, it is completely optional and can take up space in your EFI. If you would rather use OpenCore's built in picker. Change `PickerMode` to `Builtin` and remove `OpenCanopy.efi` from `UEFI` > `Drivers`.
-
-* OpenCore tools and utilities are removed for a clean setup and can be added when needed.
-
-## Updating:
-
-To update your OpenCore folder to my current version, simply backup your `PlatformInfo` information and move it to the new OpenCore config. Keep in mind that, depending on your setup, you may wish to keep other settings you've made so make sure to note your OpenCore `config.plist` changes as you make them.

docs/hardware/optimizing-hardware.md

@@ -0,0 +1,7 @@
+## Repaste the Cooler
+
+- [Grizzly Kryonaut](https://www.thermal-grizzly.com/en/products/16-kryonaut-en) is commonly recommended. You may also look into other brands such as Noctua or Arctic.
+- [Grizzly Conductonaut](https://www.thermal-grizzly.com/produkte/25-conductonaut) is a higher performant option (being liquid metal) at the risk of killing the machine if improperly applied. 
+
+## Replace the Fan (if applicable)
+- See https://www.reddit.com/r/thinkpad/comments/c7zpah/x1_carbon_6th_gen_horrible_cooling_fan_design/

docs/hardware/parts-replacements.md

@@ -0,0 +1,31 @@
+## Storage
+
+!!! Warning
+    The factory PM981 NVMe drive does not play well with macOS.
+
+For installation on the factory drive `PM981`, please refer to [Issue #43](https://github.com/tylernguyen/x1c6-hackintosh/issues/43). I do, however, recommend against this. 
+
+
+!!! Note
+    Replace the PM981 with an aftermarket NVMe for a much smoother experience.
+
+Consult the [dortania/Anti-Hackintosh-Buyers-Guide](https://dortania.github.io/Anti-Hackintosh-Buyers-Guide/Storage.html) for up-to-date storage recommendations.
+
+!!! Tip
+    You can install an additional M.2 2242 NVMe drive in the WWAN card slot.
+
+This is very useful if you intend to also use Windows/Linux, as partitioning a single drive for dual booting can be troublesome.
+
+## WiFi and Bluetooth
+
+!!! Tip
+    If your laptop did not come with WWAN, you can purchase additional antennas to add to your laptop. This is useful when using WiFi/Bluetooth cards that have 3 antennas.
+
+- The laptop's default wireless card should work via the [OpenIntelWireless](https://github.com/OpenIntelWireless) kexts.
+- For a vanilla and native experience, you may wish to buy a BCM94360CS2 card, along with a M.2 NGFF adapter. 
+- For future proofing and the fastest wireless/bluetooth speed, I recommend the AX200 (the card I am using). This card will also require the various [OpenIntelWireless](https://github.com/OpenIntelWireless) kexts.
+
+!!! Note
+    See `patches/Network Patches/` for OpenCore patches for custom wireless cards.
+
+- You should also see [`dortania/Wireless-Buyers-Guide`](https://dortania.github.io/Wireless-Buyers-Guide/).  

docs/index.md

@@ -1,21 +1,31 @@
-# FAQ
+---
+hide:
+  - navigation
+---
 
-#### "Does everything work?"
+## FAQ
-Not everything, some features will inherently never work under macOS. The most needed, day-to-day features, however, work as they do in a real Mac. See [Summary](https://tylernguyen.github.io/x1c6-hackintosh/Summary/).
+
+#### Does everything work?
+
+The core, majority functions work. Notable non-functional features include the fingerprint reader, WWAN, and USB 3.1 hotplug.
+
+#### Is this project maintained?
 
-#### "Is this project maintained?"
 Yes, until eventually my x1c6 dies or macOS phases out update (even then, it'll likely last a few more years).
 
-#### "Can this brick my laptop?"
+#### Can this brick my laptop?
+
 Not very likely, expect drive wipes and lost time, however.
 
-#### "Can you port this for X machine?"
+#### Can you port this for X machine?
+
 No.
 
-#### "How do I keep my Hackitnosh setup updated?"
+#### How do I keep my Hackintosh setup updated?
-Currently, there is no automatic solution available. For now, I recommend you create a GitHub watch alert.
 
-# References
+Currently, there is no automatic solution available. For now, I recommend you create a GitHub watch alert and update the EFI as it comes along.
+
+## Basic References
 
 !!! warning
     Please read, or at the least, browse through these great resources to get an idea of what's going on before proceeding. This is especially important if this is your first time (OpenCore) Hackintosh-ing.
@@ -33,18 +43,67 @@ Currently, there is no automatic solution available. For now, I recommend you cr
 
 - Additionally, references specific to the x1c6 are located in `docs/references/`
 
-# Requirements
+# Function Summary
 
-## Strict requirements
+### Non-Fuctional:
-- Flash drive, 12GB or more.
+| Feature                              | Status | Dependency          | Remarks                      |
-- Patience and time, especially if this is your first time Hackintosh-ing.
+| :----------------------------------- | ------ | ------------------- | ---------------------------- |
+| Fingerprint Reader   | ❌ | `DISABLED` in BIOS to save power if not used in other OSes.   | Linux support was only recently added    |
+| Wireless WAN         | ❌ | `DISABLED` in BIOS to save power if not used in other OSes.   | Unable to investigate as I have no need and my model did not come with WWAN. |
+| Load Apple's Graphics Micro Code (GuC) | ❌ | | See [Issue #103](https://github.com/tylernguyen/x1c6-hackintosh/issues/103). Will never work AFAIK due to inherent incompatibility. |
 
-## Optional
+### Video and Audio
-- A macOS machine to create an offline macOS installer.
+| Feature                              | Status | Dependency          | Remarks                      |
-- [SPI Programmer CH341a and SOIC8 connector](https://www.amazon.com/Organizer-Socket-Adpter-Programmer-CH341A/dp/B07R5LPTYM) are needed if you are going to mod your BIOS.
+| :----------------------------------- | ------ | ------------------- | ---------------------------- |
-- Xcode works fine for editing plist files on macOS, but I prefer [PlistEdit Pro](https://www.fatcatsoftware.com/plisteditpro/).  
+| Full Graphics Accleration (QE/CI)    | ✅   | `WhateverGreen.kext`                   | -   |
-- [ProperTree](https://github.com/corpnewt/ProperTree) if you need to edit plist files on Windows.  
+| Audio Recording                      | ✅   | `AppleALC.kext` with Layout ID = 21    | -   |
-- [MaciASL](https://github.com/acidanthera/MaciASL), for patching ACPI tables and editing ACPI patches.
+| Audio Playback                       | ✅   | `AppleALC.kext` with Layout ID = 21    | -   |
-- [MountEFI](https://github.com/corpnewt/MountEFI) to quickly mount EFI partitions.  
+| Automatic Headphone Output Switching | ✅   | `AppleALC.kext` with Layout ID = 21    | -   |
-- [IORegistryExplorer](https://developer.apple.com/downloads), for diagnosis.  
+
-- [Hackintool](https://www.insanelymac.com/forum/topic/335018-hackintool-v286/), for diagnostic ONLY, Hackintool should not be used for patching, it is outdated.
+### Power, Charge, Sleep and Hibernation
+| Feature                              | Status | Dependency          | Remarks                      |
+| :----------------------------------- | ------ | ------------------- | ---------------------------- |
+| Battery Percentage Indication | ✅    | `SSDT-Battery.aml` and `/patches/OpenCore Patches/Battery.plist`             | 
+| CPU Power Management (SpeedShift)    | ✅      | `XCPM` and `CPUFriend.kext`, generate your own `CPUFriendDataProvider` with [CPUFriendFriend](https://github.com/corpnewt/CPUFriendFriend_) or [one-key-cpufriend](https://github.com/stevezhengshiqi/one-key-cpufriend). |
+| iGPU Power Management        | ✅ | `XCPM`, enabled by `SSDT-PM.aml`                   | 
+| NVMe Drive Battery Management | ✅     | `NVMeFix.kext`  | In my experience, NVMe drives will drain more power than SATA drives.           |
+| S3 Sleep/ Hibernation Mode 3 | ✅ | `SSDT-Sleep.aml` | |
+| Hibernation Mode 25          | ✅ | `RTCMemoryFixup.kext` and `HibernationFixup.kext`      | Supported, macOS uses mode 3 by default. Change to mode 25 via `pmset`.     |   
+| Custom Charge Threshold      | ✅ | `SSDT-EC.aml`, [YogaSMC.kext](https://github.com/zhen-zen/YogaSMC), and [YogaSMCPane](https://github.com/zhen-zen/YogaSMC)| Adjust with YogaSMCPane in System Preferences
+| Fan Control                  | ✅ | `SSDT-EC.aml`, [YogaSMC.kext](https://github.com/zhen-zen/YogaSMC), and [YogaSMCPane](https://github.com/zhen-zen/YogaSMC)| Adjust with YogaSMC App.
+| Battery Life                 | ✅ | Native, comparable to Windows/Linux. Biggest impact is TB3, see [docs/BIOS.md](https://tylernguyen.github.io/x1c6-hackintosh/BIOS/)   | Will need a modded BIOS to disable `CFG Lock`
+
+
+### Input/ Output
+| Feature                              | Status | Dependency          | Remarks                      |
+| :----------------------------------- | ------ | ------------------- | ---------------------------- |
+| WiFi                                       | ✅ | Native with `BCM94360CS2`, Intel `AX200` is preferred. | See `/patches/ Network Patches/` for patches.        |
+| Bluetooth                                  | ✅ | Native with `BCM94360CS2`. Intel `AX200` is preferred. | See `/patches/ Network Patches/` for patches.        |
+| Ethernet                                   | ✅ | `IntelMausi.kext` | Needs Lenovo Ethernet adapter: [Item page](https://www.lenovo.com/us/en/accessories-and-monitors/cables-and-adapters/adapters/CABLE-BO-Ethernet-Extension-Adapter-2/p/4X90Q84427) |
+| HDMI hotplug                               | ✅ | Custom EDID Override `/patches/Internal Displays/`                                                                  | Refer to [Issue #60](https://github.com/tylernguyen/x1c6-hackintosh/issues/60) if one does not exist already for your display. |
+| 4K UHD output via HDMI/ DisplayPort **(Modded BIOS)**  | ✅ | See `DMVT Pre-Allocated` to `64M`  | See [docs/BIOS.md](https://tylernguyen.github.io/x1c6-hackintosh/BIOS/) for information about modding the BIOS.           |
+| 4K UHD output via HDMI/ DisplayPort **(Vanilla BIOS)** | ✅ | See `/patches/OpenCore Patches/4K-Output-wo-BIOSmod.plist`     | -           |
+| USB 2.0, USB 3.0, and Micro SD Card Reader | ✅ | `SSDT-XHC1.aml`    | -     |
+| USB 3.1                                    | ⚠️ | `SSDT-TB-DSB2-XHC2.aml`    | Hotplug WIP     |
+| USB Power Properties in macOS              | ✅ | `SSDT-XHC1.aml`    | -     |
+| Thunderbolt 3 Hotplug                      | ✅ | `SSDT-TB-*`     | Native interface within System Report   |
+
+### Display, TrackPad, TrackPoint, and Keyboard
+| Feature                              | Status | Dependency          | Remarks                      |
+| :----------------------------------- | ------ | ------------------- | ---------------------------- |
+| Brightness Adjustments | ✅  | `WhateverGreen.kext`, `SSDT-PNLF.aml`, and `BrightnessKeys.kext`| |
+| HiDPI _(Optional)_     | ✅  | [xzhih/one-key-hidpi](https://github.com/xzhih/one-key-hidpi)   | Scaling issues post-sleep fixed with AAPL, ig-platform `BAAnWQ==`     |
+| TrackPoint             | ✅  | `VoodooPS2Controller.kext`                                      | -       |
+| TrackPad               | ✅  | `VoodooPS2Controller.kext` or `VoodooSMBus.kext` and `VoodooRMI.kext`     | `VoodooRMI.kext` is recommended and preferred over `VoodooPS2`. |
+| Built-in Keyboard      | ✅  | `VoodooPS2Controller.kext` | Optimizations recommended, see [`docs/Post-Installation.md`](https://tylernguyen.github.io/x1c6-hackintosh/Post-Installation/) |
+| Multimedia Keys        | ✅  | `BrightnessKeys.kext` and [YogaSMC](https://github.com/zhen-zen/YogaSMC) | `YogaSMC` is recommended and preferred over ThinkpadAssisstant  | 
+
+### macOS Continuity
+| Feature                              | Status | Dependency          | Remarks                      |
+| :----------------------------------- | ------ | ------------------- | ---------------------------- |
+| iCloud, iMessage, FaceTime | ✅ | Whitelisted Apple ID, Valid SMBIOS   | See [dortania /OpenCore-Install-Guide](https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html)  |
+| Continuty              | ✅     | Native with `BCM94360CS2`. `ExtendBTFeatureFlags` to `True` otherwise.       | See `/patches/Network Patches/` for specific network card.     |
+| AirDrop                | ✅     | Native with `BCM94360CS2`. `ExtendBTFeatureFlags` to `True` otherwise.       | See `/patches/Network Patches/` for specific network card.     |
+| Sidecar                | ✅     | Native with `BCM94360CS2`. `ExtendBTFeatureFlags` to `True` otherwise. iPad with >= `iPadOS 13`  | Tested with iPad Mini with iPadOS 13.1.2   |
+| FileVault              | ✅ | as configured in `config.plsit` per [Dortania's Post-Install](https://dortania.github.io/OpenCore-Post-Install/universal/security/filevault.html)|  |
+| Time Machine           | ✅     | Native | TimeMachine only backups your Macintosh partition. Manually backup your EFI partition using another method.  |

docs/installing-macOS.md

@@ -0,0 +1,36 @@
+---
+hide:
+  - navigation
+---
+
+## Creating the macOS Installer
+
+Start by creating a vanilla macOS installer, refer to [Dortania's Creating the USB](https://dortania.github.io/OpenCore-Install-Guide/installer-guide/).
+
+You may also use [`createinstallmedia`](createinstallmedia) if you already have a Mac.
+
+!!! tip
+    Often as above, the project will defer universal steps to Dortania links. Hence, this repository is meant to be used in conjunction with their guides.  
+
+## EFI Partition
+
+1. Make the following changes to `config.plist` within the `EFI` folder.
+    
+    - `ShowPicker` to `YES`
+    - If your machine has a vanilla (unmodded) BIOS, merge `/patches/ OpenCore Patches/ Vanilla BIOS.plist` with `config.plist`
+
+!!! note
+    It is generally a good idea to keep the install media around. As you tweak your own OpenCore `config.plist`, things may break and you will not be able to get back into macOS using the system's OpenCore. In those times, you can use the install drive to boot into macOS.
+
+2. Mount the installer media's EFI parition. You may do this via the command line with `diskutil` or via a utility like [corpnewt/MountEFI](https://github.com/corpnewt/MountEFI).
+
+3. Copy the EFI folder into the installer media's EFI partition. Remember that the top directory level should be `EFI`.
+
+4. Boot into the macOS installer envrionemnt using the media. Format target disk as `APFS` using `Disk Utility` and complete installation.
+
+5. Once macOS has been installed, boot the installed macOS paritition with the existing installer USB and complete new user setup.
+
+6. Copy `EFI` onto the macOS drive's EFI partition. Set `ShowPicker` to `NO` for a cleaner boot experience. You can still access the boot picker by pressing `ESC` during boot time.
+
+!!! success
+    At this point, your machine should boot into macOS without anything attached.

docs/overrides/main.html

@@ -0,0 +1,5 @@
+{% extends "base.html" %}
+
+{% block announce %}
+  Support and follow my work at <a href="https://damnthattelevision.com/">Damn That Television</a>
+{% endblock %}

docs/post-installation/display.md

@@ -0,0 +1,9 @@
+## HiDPI, specfically, HiDPI for the WQHD-HDR 1440p Display
+
+- Run [xzhih/one-key-hidpi](https://github.com/xzhih/one-key-hidpi)
+
+## EDID Override
+
+- This is necessary to fix HDMI hotplug.
+- See current available patches in `/patches/Internal Displays/`, merge them with `config.plist`
+- If a patch is not yet created for your display model. Please see [Issue #60](https://github.com/tylernguyen/x1c6-hackintosh/issues/60) to create your own EDID override. Please create a pull request to add your EDID override for different displays.

docs/post-installation/dual-booting.md

@@ -0,0 +1,4 @@
+- I recommend that you dual boot using another drive in the WAN slot (I have the WDC PC SN520 NVMe 2242). This makes installation much easier, and lets the BIOS F12 option act as your boot manager.
+- I've found that dual booting with OpenCore on a single can be quite troublesome. Instead, what I recommend is to use rEFInd Boot Manager should you need to dual boot Windows or Linux.
+- It is possible to share Bluetooth pairing keys between Windows and macOS when dual booting. 
+  - The `.reg` for Bluetooth connected devices in macOS can be exported using Hackintool's Utilities section. This key can then be imported to Windows.

docs/post-installation/iServices.md

@@ -0,0 +1,2 @@
+- Refer to [dortania /OpenCore-Install-Guide](https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html)
+- NOTE: `We’re sorry, but this serial number isn’t valid` is fine and has personally worked and working for me and many others. `Purchase Date not Validated` can be a problem down the line if a legitimate machine with that PlatformInfo is activated.

docs/post-installation/keyboard.md

@@ -0,0 +1,8 @@
+- PrtSc (remapped to F13) = I use it for Screen Capture (Set in `System Preferences/Keyboard/Shortcuts`)
+- Check `Use F1, F2, etc. keys as standard function keys` in `System Preferences/Keyboard` to gain access to standard F keys:  
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/tylernguyen/x1c6-hackintosh/main/docs/img/keyboard.png" width="400">
+</p>
+
+- Additionally, [Karabiner-Elements](https://karabiner-elements.pqrs.org/) and [BetterTouchTool](https://folivora.ai/) are great productivty tools to remap and/or add functions to your keyboard.

docs/post-installation/sleep.md

@@ -0,0 +1,12 @@
+- Disable Power Nap for both [`Battery`](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/assets/macOS%20Settings/Battery_powernap.png) and [`Power Adapter`](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/assets/macOS%20Settings/Poweradt_powernap.png).
+- Disable [`Wake for Network Access`](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/assets/macOS%20Settings/Poweradt_powernap.png) in `Power Adapter`.
+
+- Uncheck `Allow Bluetooth devices to wake this computer` if you do not need it.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/tylernguyen/x1c6-hackintosh/main/docs/img/bluetooth.png" width="400">
+</p>
+
+- Do not disable `hibernatefile`.
+- `sudo pmset -a tcpkeepalive 0` to disable Network while sleeping.
+- `sudo pmset -a proximitywake 0` to disable peripheral wake agent.

docs/post-installation/thunderbolt-3.md

@@ -0,0 +1,11 @@
+- Native-like integration with macOS in System Report without the need of flashing a modded firmware. Thank you @benbender
+- NOTE: If you do have a modded BIOS firmware, please reset all settings relating to Thunderbolt 3 to default, all that's needed are settings detailed below or in [1_README-HARDWAREandBIOS.md](https://github.com/tylernguyen/x1c6-hackintosh/blob/main/docs/1_README-HARDWAREandBIOS.md)  
+- Please make sure of these settings in BIOS:  
+
+| Main Menu | Sub 1       | Sub 2                                         | Sub 3                                                              |
+| --------- | ----------- | --------------------------------------------- | ------------------------------------------------------------------ |
+|           | >> Config   | >> Thunderbolt (TM) 3                         | Thunderbolt BIOS Assist Mode `Disabled`                            |
+|           |             |                                               | Security Level `No Security`                                       |
+|           |             |                                               | Support in Pre Boot Environment: Thunderbolt(TM) Device `Disabled` |
+
+- Note: USB 3.1 Gen2 hotplug still Work-in-progress.

docs/post-installation/trackpad.md

@@ -0,0 +1,7 @@
+- Force Click is enabled by default, which turns any click on the trackpad into a force touch. I suggest you turn this off.
+- In addition, I prefer to have tap to click on:  
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/tylernguyen/x1c6-hackintosh/main/docs/img/touchpad.png" width="400">
+</p>
+

docs/technical/config.plist.md

@@ -0,0 +1,69 @@
+## Checking your OpenCore config.plist
+
+When editing `config.plist`, confirm proper syntax by running `ocvalidate config.plist`.
+
+## `config.plist` Comments:
+
+* The default `config.plist` is meant to serve a mostly vanilla configuration. Additional `config.plist` compoments are available in [x1c6-hackintosh/patches/](https://github.com/tylernguyen/x1c6-hackintosh/tree/main/patches)
+
+
+#### Audio patches:   
+
+`Device Properties` > `PciRoot(0x0)/Pci(0x1f,0x3)` > `layout-id`: Injects AppleALC layout-id `21`
+
+#### Intel iGPU and HDMI patches:
+
+`Device Properties` > `PciRoot(0x0)/Pci(0x2,0x0)` >  
+
+- `device-id` = `16590000` per [WhateverGreen/IntelHD.en.md](https://github.com/acidanthera/WhateverGreen/blob/main/Manual/FAQ.IntelHD.en.md)
+- `AAPL,ig-platform-id` = This is negotiable. In the future, I will test different variables for optimization. For now, `04002759` works well enough. 
+- `AAPL00,override-no-connect` = EDID override to fix HDMI hotplug. Search for yours at `patches/Internal Displays/` or see [Issue #60](https://github.com/tylernguyen/x1c6-hackintosh/issues/60) to create one for your display model.
+- `framebuffer-con1-enable` to enable framebuffer patching by WEG on connector 1.
+- `framebuffer-con1-type` to set connector 1 type to HDMI (per IOReg)
+- `framebuffer-patch-enable` tells WEG to patch framebuffer.
+- `AAPL00,override-no-connect` to override EDID (dependent on display models). See `patches/Internal Displays/`. This is necessary to fix HDMI hotplug. To create your own, see [Issue #60](https://github.com/tylernguyen/x1c6-hackintosh/issues/60)
+
+#### FileVault compatibility:
+
+- Misc -> Boot
+    - `PollAppleHotKeys` set to `YES`(While not needed can be helpful)
+- Misc -> Security
+    - `AuthRestart` set to `YES`(Enables Authenticated restart for FileVault 2 so password is not required on reboot. Can be considered a security risk so optional)
+- NVRAM -> Add -> 4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14
+    - `UIScale` set to `02` for high resolution small displays
+- UEFI -> Input
+    - `KeySupport` set to `YES`(Only when using OpenCore's builtin input, users of OpenUsbKbDxe should avoid)
+- UEFI -> Output
+    - `ProvideConsoleGop` to `YES`
+- UEFI -> ProtocolOverrides
+    - `FirmwareVolume` set to `YES`
+    - `AppleSmcIo` set to `YES`(this replaces VirtualSMC.efi)
+- UEFI -> Quirks
+    - `RequestBootVarRouting` set to `YES`
+
+#### Hibernation Mode 25 support:
+
+- Booter -> Quirks
+    - `DiscardHibernateMap` set to `YES`
+- NVRAM -> Add -> 7C436110-AB2A-4BBB-A880-FE41995C9F82
+    - `boot-args` includes `-hbfx-dump-nvram rtcfx_exclude=80-AB`
+- Misc -> Boot
+    - `HibernateMode` set to `NVRAM`
+- UEFI -> ReservedMemory
+    - Address: `569344`
+    - Size: `4096`
+    - Type: `RuntimeCode`
+
+#### Personalization:
+
+- `ShowPicker` is `No`. Use `Esc` during boot to show picker when needed.
+- `PickerMode` is `External` to use `OpenCanopy` boot menu. If you prefer a lighter `EFI`, delete `Resources` and switch variable to `Builtin`.
+- `PlayChime` is `No`. Set this to `Yes` if you want the native chime to play upon boot.
+ 
+#### OpenCanopy Support:  
+
+I prefer OpenCanopy for its looks. However, it is completely optional and can take up space in your EFI. If you would rather use OpenCore's built in picker. Change `PickerMode` to `Builtin` and remove `OpenCanopy.efi` from `UEFI` > `Drivers`.
+
+#### EFI Tools
+
+* OpenCore tools and utilities are removed for a clean setup and can be added when needed.

mkdocs.yml

@@ -10,19 +10,32 @@ edit_uri: ""
 
 nav:
     - Home: index.md
-    - Summary: Summary.md
+    - Hardware:
-    - Hardware: Hardware.md 
+      - Parts Replacements: hardware/parts-replacements.md
-    - BIOS: BIOS.md
+      - Optimizing Hardware: hardware/optimizing-hardware.md
-    - Getting Started: Getting-Started.md
+    - BIOS:
-    - Post Installation: Post-Installation.md
+      - Settings for Vanilla BIOS: BIOS/settings-for-vanilla-BIOS.md
-    - Issues: Issues.md
+      - Modding the BIOS (optional): BIOS/modding-the-BIOS.md
+      - Settings for Modded BIOS: BIOS/settings-for-modded-BIOS.md
+    - Installing macOS: installing-macOS.md
+    - Post Installation:
+      - iCloud, iMessage, FaceTime: post-installation/iServices.md
+      - Dual Booting: post-installation/dual-booting.md
+      - Sleep: post-installation/sleep.md
+      - Display: post-installation/display.md
+      - Thunderbolt 3: post-installation/thunderbolt-3.md
+      - Keyboard: post-installation/keyboard.md
+      - Trackpad: post-installation/trackpad.md
+    - Issues: issues.md
     - Technical Details:
-      - config.plist: config.plist.md
+        Internal:
-      - Patches: Patches.md
+          - config.plist: technical/config.plist.md
+          - patches: technical/patches.md
+          - Keyboard Queries: techical/keyboard-queries.md
+          - ALC285 Codec: tecnical/ALC285.md
+          - EC Queries: tecnical/EC-queries.md
+        External:
           - ACPI Patch Snippets: https://github.com/5T33Z0/OC-Little-Translated
-      - Keyboard Map: references/Keyboard.md
-      - ALC285 Codec: references/ALC285.md
-      - EC Queries: references/EC_queries.md
           - ASL Tutorial: https://acpica.org/sites/acpica/files/asl_tutorial_v20190625.pdf
           - ACPI Tips and Tricks: https://wiki.ubuntu.com/Kernel/Reference/ACPITricksAndTips
           - WhateverGreen Intel HD Manual: https://github.com/acidanthera/WhateverGreen/blob/master/Manual/FAQ.IntelHD.en.md
@@ -38,14 +51,21 @@ nav:
 
 theme:
   name: material
+  icon:
+    logo: material/laptop
+  custom_dir: docs/overrides
   palette:
-    primary: blue grey
+    scheme: default
+    primary: deep orange
     accent: red
   features:
     - header.autohide
     - search.highlight
     - search.suggest
-    - navigation.sections
+    - navigation.instant
+    - navigation.top
+    - navigation.tabs
+    - navigation.tabs.sticky
     - navigation.tracking
   
 extra:
@@ -55,8 +75,17 @@ extra:
 
 plugins:
   - search
-  - mermaid2
 
 markdown_extensions:
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
   - admonition
+  - pymdownx.details
+  - pymdownx.superfences
   - footnotes

requirements.txt

@@ -1 +0,0 @@
-mkdocs-mermaid2-plugin