From f60030c13b825187043e34e404fd4b28e0281369 Mon Sep 17 00:00:00 2001 From: Tyler Nguyen Date: Mon, 8 Aug 2022 01:48:01 -0500 Subject: [PATCH] mkdocs: improve readability --- docs/BIOS/modding-the-BIOS.md | 2 +- docs/hardware/optimizing-hardware.md | 18 ++++++++++++++++-- docs/technical.md | 10 +++++----- 3 files changed, 22 insertions(+), 8 deletions(-) diff --git a/docs/BIOS/modding-the-BIOS.md b/docs/BIOS/modding-the-BIOS.md index 0f978e0..aee25c9 100644 --- a/docs/BIOS/modding-the-BIOS.md +++ b/docs/BIOS/modding-the-BIOS.md @@ -6,7 +6,7 @@ A modded BIOS will allow for more optimizations to be made for macOS and will ov !!! recommendation - ![CH341a SPI Programmer and SOIC8 Clip](/docs/img/CH341a.png){ align=right } + ![CH341a SPI Programmer and SOIC8 Clip](/img/CH341a.png){ align=right } The CH341a SPI Programmer and SOIC8 Clip are needed to dump, mod, and flash the BIOS chip. There are better and more profession alternative devices but I've found this one to be adequate for the job. diff --git a/docs/hardware/optimizing-hardware.md b/docs/hardware/optimizing-hardware.md index 3fd5e73..ff37998 100644 --- a/docs/hardware/optimizing-hardware.md +++ b/docs/hardware/optimizing-hardware.md @@ -5,8 +5,22 @@ ## Replace the Fan (if applicable) -- See https://www.reddit.com/r/thinkpad/comments/c7zpah/x1_carbon_6th_gen_horrible_cooling_fan_design/ +!!! info + + tl;dr - The X1C6 has different cooler fan manufacturers, and they differ greatly in noise and performance. + + [Learn more from reddit.com](https://www.reddit.com/r/thinkpad/comments/c7zpah/x1_carbon_6th_gen_horrible_cooling_fan_design/){ .md-button .md-button--primary } ## Battery Replacement -- Depending on the battery health (cycle count, max capacity), consider getting a battery replacement. See [Lenovo Part 01AV494](https://lenovo.encompass.com/item/11537594/Lenovo/01AV494/). Avoid battery replacements from eBay as their autheticity cannot be verified. \ No newline at end of file +!!! recommendation + + ![Lenovo Part 01AV494](https://encompass-11307.kxcdn.com/imageDisplay?id=11537594&mfgCode=LEN&size=s){ align=right } + + Depending on the battery health (cycle count, max capacity), consider getting a battery replacement. + + !!! warning + + Avoid battery replacements from eBay as their autheticity cannot be verified. Addtionaly, their reported capacity, cycle count, and longevity can be misleading. + + [Purchase from lenovo.encompass.com](https://lenovo.encompass.com/item/11537594/Lenovo/01AV494/){ .md-button .md-button--primary } \ No newline at end of file diff --git a/docs/technical.md b/docs/technical.md index f6166d1..0406a13 100644 --- a/docs/technical.md +++ b/docs/technical.md @@ -1,4 +1,4 @@ -## Internal Technical Details on the X1C6 +## Internal Resources !!! note @@ -16,23 +16,23 @@ 6. JackSense, EAPD, and AppleALC Patch Explaination: [Issue #75/ comment by ghost](https://github.com/tylernguyen/x1c6-hackintosh/issues/75#issuecomment-705889447) -## External Technical Details +## External Resources ### ACPI, ASL, and Patches -1. The patches written for this project are in ASL. Consder reading the [ACPI Source Language (ASL) Tutorial v20190625](https://acpica.org/sites/acpica/files/asl_tutorial_v20190625.pdf) to get a basic understanding of the patches' code. +- The patches written for this project are in ASL. Consder reading the [ACPI Source Language (ASL) Tutorial v20190625](https://acpica.org/sites/acpica/files/asl_tutorial_v20190625.pdf) to get a basic understanding of the patches' code. !!! info The Ubuntu Wiki also has an [ACPI Tricks and Tips](https://wiki.ubuntu.com/Kernel/Reference/ACPITricksAndTips) section. -2. [5T33Z0/OC-Little-Translated](https://github.com/5T33Z0/OC-Little-Translated) is the English docs translation of [daliansky/OC-little](https://github.com/daliansky/OC-little). It is helpful to refer to existing patches when Hackintoshing. +- [5T33Z0/OC-Little-Translated](https://github.com/5T33Z0/OC-Little-Translated) is the English docs translation of [daliansky/OC-little](https://github.com/daliansky/OC-little). It is helpful to refer to existing patches when Hackintoshing. !!! warning Some patches within OC-Little can be oudated, badly done, or fragmented because of different patch authors. Consider using this resource only as a reference and basic guide, not a patch repository. -3. Consider referencing the [MacbookPro14,1 ACPI Dump](https://github.com/khronokernel/DarwinDumped/tree/master/MacBookPro/MacBookPro14%2C1) when trying to understand certain functions within macOS. +- Consider referencing the [MacbookPro14,1 ACPI Dump](https://github.com/khronokernel/DarwinDumped/tree/master/MacBookPro/MacBookPro14%2C1) when trying to understand certain functions within macOS. ### Acidanthera Official Docs