Merge pull request #7 from CoolPenguin27/vuepress-rebase

Merge Chrultrabook chrultrabook#102 PR into vuepress rebase

LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

README.md

@@ -1,37 +1,3 @@
-# EmulatorJS Website
+## Chrultrabook Docs
+Centralized project documentation 
 
-This is the official website for the EmulatorJS project.
-Here you will find information on any prerequisites needed, installation & setup processes and advanced configuration options.
-
-Note: This website is built upon vuepress.
-
-Made with ❤️ by [@ethanaobrien](https://github.com/ethanaobrien) & [@allancoding](https://github.com/allancoding)
-
-## Contributing
-
-In order to contribute, you will need the following:
-
-* Node.js 10+
-* Yarn (not technically required)
-* Vuepress (part of nodejs)
-* A code editor like Visual Studio Code (or notepad++)
-
-### Development
-
-Run the following commands one after the other. (run with `npm` instead of `yarn` if you're too lazy to install yarn)
-
-Install Dependencies
-
-```sh
-yarn install
-```
-
-Lastly, run the following to spin up and webhost the project
-
-```sh
-yarn dev_new
-```
-
-It can now be reached at http://localhost:8080/.
-
-NOTE: Whenever you make any changes to the vuepress `config.js` file, close the running node program and re-reun `yarn dev_new`

src/.vuepress/config.js

@@ -45,6 +45,10 @@ export default {
             text: 'Finding System Info',
             link: '/docs/system-info',
           },
+          {
+            text: 'Recovery Mode',
+            link: '/docs/recovery-mode',
+          },
           {
             text: 'Enabling Developer Mode',
             link: '/docs/developer-mode',
@@ -115,6 +119,10 @@ export default {
             text: 'Reverting to ChromeOS',
             link: '/docs/reverting',
           },
+          {
+            text: 'Exiting Developer Mode',
+            link: '/docs/exiting-developer-mode',
+          },
           {
             text: 'Using Ventoy within ChromeOS',
             link: '/docs/ventoy',

src/docs/allaboutfirmware.md

@@ -56,7 +56,7 @@ The (UEFI) Full ROM firmware is the best option for all users who no longer need
       <a href="getting-started.html">← Getting Started</a>
     </td>
     <td class="navtable-r">
-      <a href="firmware.html">Flashing Firmware →</a>
+      <a href="flashing-firmware.html">Flashing Firmware →</a>
     </td>
   </tr>
 </table>

src/docs/altos.md

@@ -37,7 +37,7 @@ Cons:
 * AVS and SOF users experience instability at times
 
    ::: warning
-   Anything Ubuntu based will **not** work, with the exception of PopOS. Linux Mint, Ubuntu, and ElementaryOS are some examples. 
+   Ubuntu and Ubuntu-based distributions that are not based on 23.10 or higher **may have issues**.
    :::
 
 <br>
@@ -72,7 +72,7 @@ Any Chromebook with a ARM, Celeron or Pentium CPU is not supported. AMD Ryzen mi
 <table>
 <tr>
 <td class="navtable">
-<a href="firmware.html">← Flashing Coreboot Firmware</a> 
+<a href="flashing-firmware.html">← Flashing Firmware</a> 
 </td>
 </tr>
 </table>

src/docs/developer-mode.md

@@ -6,14 +6,43 @@ Enabling [developer mode](https://chromium.googlesource.com/chromiumos/docs/+/HE
 Doing this will wipe **all** user data! Make backups if needed before proceeding.
 :::
 
+::: danger
+Do not continue if your device is currently owned or enrolled by a organization, such as a school or employer. Unless you were given permission by your organization, its a crime.
+:::
+
 ::: tip
 The battery must be plugged in while enabling developer mode.
 :::
 
-1. Press `esc` `refresh` (f3) and `power` at the same time. Doing this should cause your system to reboot into a screen that prompts you to insert a recovery USB or SD card.
-2. Press `ctrl` and `d` at the same time. Your system will reboot to an "unverified" mode.
-3. Use the hotkey `ctrl` + `d` to boot chromeos.
-4. Once it boots, you should be in Developer Mode. **Do not enable debugging features.**
-5. Setup the system as you would on any other Chromebook.
+Developer Mode is an alternate mode that all chromeOS devices have that opens up the ability to make unverified changes to the operating system and hardware.
+
+1. Enter [recovery mode](recovery-mode.html).
+
+**Chromebooks/Chromeboxes**
+
+1. Press `CTRL` +  `D` at the same time. This should bring up a warning asking for confirmation for either "Turn OS Verification OFF" or "Enable Developer Mode".
+
+2. Press `Enter`. The system should reboot and bring you to the "You are in Developer Mode" or "OS Verification is OFF" screen.
+
+3. Press `CTRL` +  `D` to boot from internal disk.
+
+4. Setup the system like normal, but **do not enable debugging features**.
+
+**Tablets**
+
+1. Press `Volume Up` + `Volume Down` to bring up the menu selection screen.
+
+2. Use the `Volume Up` and `Volume Down` to navigate to  "Confirm Enabling Developer Mode", then press `Power` to select it. The system should reboot and bring you to the OS Verification is OFF" screen.
+
+3. Select "Developer Options", then select "Boot from Internal Disk".
 
-Congratulations! You've enabled developer mode!
+<table>
+<tr>
+<td class="navtable-l">
+<a href="recovery-mode.html">← Recovery Mode</a> 
+</td>
+<td class="navtable-r">
+<a href="flashing-firmware.html">Flashing Firmware →</a> 
+</td>
+</tr>
+</table>

src/docs/exiting-developer-mode.md

@@ -0,0 +1,44 @@
+## Exiting Developer Mode
+
+::: danger
+Entering and exiting Developer mode will **wipe all** user data!
+Backup anything if you have to.
+:::
+
+### Reset GBB Flags
+If you get this error "WARNING: TONORM prohibited by GBB_FORCE_DEV_SWITCH_ON" or find the "Return to secure mode" button missing, you need to reset your gbb flags. 
+
+1. Boot chromeOS.
+
+2. Press `Control` + `Alt` + `T` to bring up a crosh terminal.
+
+3. Run [MrChromebox's firmware utility script.](https://mrchromebox.tech/#fwscript)
+    * Type `cd; curl -LO mrchromebox.tech/firmware-util.sh && sudo bash firmware-util.sh` and press Enter.
+    * If you encounter certificate related errors when downloading the script from ChromeOS, then add `-k` to the `curl` and script command to bypass SSL certificate checking as so:
+        * `cd; curl -LOk mrchromebox.tech/firmware-util.sh && sudo bash firmware-util.sh` 
+
+4. Select option 3: "Set Boot Options (GBB flags)".
+
+5. Select option 5: "Reset to factory default".
+
+6. Your done.
+
+
+### Exiting Developer Mode
+
+1. Boot your system to the "You are in Developer Mode" or "OS Verification is OFF" screen.
+
+**Chromebooks/Chromeboxes**
+
+1. Press the `Spacebar`. If it brings up a warning asking for confirmation, Press `Enter`.
+
+2. Press `Enter`. The screen should turn off breifly and say that its returning to "Normal (Verified) Mode...".
+
+3. Once its done, Setup the system like normal.
+
+**Tablets**
+
+1. Select "Enable OS Verification".
+
+2. Once its done, Setup the system like normal.
+

src/docs/installing-linux.md

@@ -37,8 +37,6 @@ Debian 12 (Bookworm) requires a custom kernel, the [audio script](#fixing-audio)
 2. Plug the USB Drive into the Chromebook.
 3. Turn on the Chromebook, press `ESC` at the POST screen (when the boot logo appears), and select your USB to boot from. 
 4. Install as you would on any other computer.
-5. (Optional) Install Chultrabook Tools for fan controls, backlight controls, system information and more
-   See [Chrultrabook Controller](https://github.com/death7654/Chrultrabook-Controller)
 
 
 --------------

src/docs/installing-windows.md

@@ -52,9 +52,6 @@ If you want to create a Windows installer from ChromeOS, see the [Installing Ven
 5. Install drivers:
    See [Coolstar's Windows Install Helper](https://coolstar.org/chromebook/windows-install.html) for drivers.
 
-6. (Optional) Install Chultrabook Tools for fan controls, backlight controls, system information and more
-   see [Chrultrabook Controller](https://github.com/death7654/Chrultrabook-Controller)
-
 ---
 
 ### Paid Drivers

src/docs/post-install.md

@@ -1,5 +1,7 @@
 ## Post Install for altOS
 
+**General QOL improvements**
+* Install [Chultrabook Tools](https://github.com/death7654/Chrultrabook-Controller) for manage fan controls, backlight controls, view system information and more.
 
 ### Windows
 
@@ -24,7 +26,6 @@
 
 * Run the [audio script](https://github.com/WeirdTreeThing/chromebook-linux-audio) if you haven't already.
 * Run the [cros-keyboard-map](https://github.com/WeirdTreeThing/cros-keyboard-map) script to remap top row FX keys.
-
 **Fixing USB C on TigerLake and AlderLake**
 1. Create a file called `chromebook-usbc.service` file in `/etc/systemd/system/`
 2. Paste the following contents into the file:

src/docs/recovery-mode.md

@@ -0,0 +1,51 @@
+## Recovery Mode
+
+::: tip
+Images sourced from [Google Support](https://support.google.com/chrome/a/answer/1360642?sjid=16957732159917599441-NC#chromebox&zippy=%2Cwipe-a-chromebox) and [Asus Support](https://www.asus.com/support/FAQ/1039185/).
+:::
+
+::: tip
+Your data is unaffected in recovery mode unless you use a recovery image or enter [developer mode](entering-developer-mode.html).
+:::
+
+::: danger
+Do not continue if your device is currently owned or enrolled by a organization, such as a school or employer. Unless you were given permission by your organization, its a crime.
+::: 
+
+Recovery mode is used to restore the OS and RW regions of the firmware. It gets triggered when an issue with the device is detected, or you manually start it.
+### Entering Recovery Mode
+<br>
+
+**Chromebooks**
+
+Press `ESC` + `Refresh` (arrow icon), + `Power` at the same time. This should bring your system into recovery mode.
+- For some devices the power button is on the side.
+- Some devices may need to hold down the `Fullscreen` button (four corners icon) instead of the `Refresh` button.
+
+<img src="/recovery/recovery-keyboard-hint.png" width=500>
+
+**Chromeboxes**
+
+Find the recovery button hole. A reference of what to look for is below.
+
+<img src="/recovery/recovery-chromebox-hint.png">
+
+When you do, use something like a paper clip to hold the button down, then turn on the device. This should bring your system into recovery mode.
+You can stop holding down the button at this point.
+
+**Tablets**
+
+Hold down `Volume Up` + `Volume Down` + `Power` for 10 seconds, then release. This should bring your system into recovery mode.
+
+<img src="/recovery/recovery-tablet-hint.png" width=500>
+
+<table>
+<tr>
+<td class="navtable-l">
+<a href="allaboutfirmware.html">← All About Firmware</a> 
+</td>
+<td class="navtable-r">
+<a href="developer-mode.html">Entering Developer Mode →</a> 
+</td>
+</tr>
+</table>