Skip to content

Commit

Permalink
Markdown cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanaobrien committed Nov 26, 2023
1 parent 17dc2b6 commit ae37bf2
Show file tree
Hide file tree
Showing 26 changed files with 2 additions and 64 deletions.
2 changes: 0 additions & 2 deletions src/docs/debugging/bugreport.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Bug Reporting

<br>

So you find a bug in one of our projects, and want to report it. It's faily simple,

1. Use your brain (please)
Expand Down
13 changes: 0 additions & 13 deletions src/docs/debugging/contributing.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
# Supporting the Docs
Want to help support the docs? Well there's some ways you can help!

------------

### Contributing via Issues

Contributing via Issues is pretty simple but there are some rules:

* Reserve the issues tab exclusively for documentation-related matters; refrain from discussing personal support issues or OS installation problems there.
* When reporting a typo or suggesting better clarification, please specify the page where the issue is found. It would be helpful to avoid searching extensively for these problems.

------------

### Contributing via PRs

Some guidelines when contributing via PRs:
Expand All @@ -22,8 +18,6 @@ Some guidelines when contributing via PRs:
* Additionally, it would be appreciated if you can provide sources for significant commits. This helps us verify the validity of the information you provide.
* Ensure that the pages adhere to the markdown style used in the docs.

------------

### How to Contribute

The best way to test your commits and ensure proper formatting is by forking the repository, making and testing changes locally, then contributing with a pull request.
Expand All @@ -42,10 +36,6 @@ The best way to test your commits and ensure proper formatting is by forking the
Vuepress will automatically regenerate pages when you make changes.
:::


------------


### Tips

Some tools that make contributing a bit easier:
Expand All @@ -54,6 +44,3 @@ Some tools that make contributing a bit easier:
* [Typora](https://typora.io/) for real time markdown rendering.
* [TextMate](https://macromates.com/) for easy and powerful mass find/replace.
* [GitHub Desktop](https://desktop.github.com/) for more user friendly GUI.


------------
3 changes: 0 additions & 3 deletions src/docs/debugging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ next: false
prev: false
---
# Debugging
This page has instructions on using multiple different utilities to debug issues and modify parts of your system.

<br>

## Grabbing Logs

Expand Down
2 changes: 1 addition & 1 deletion src/docs/exiting-developer-mode.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Exiting Developer Mode
# Exiting Developer Mode

::: danger
Entering and exiting Developer mode will **wipe all** user data!
Expand Down
3 changes: 0 additions & 3 deletions src/docs/firmware/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
prev: write-protect
next: flashing-firmware
---

# Types of Firmware

## Firmware Types

### RW_LEGACY

* Updates/replaces the stock RW_LEGAGY payload (SeaBIOS or edk2) included on many older models; supplements the ChromeOS / secure boot payload (depthcharge)
Expand Down
3 changes: 0 additions & 3 deletions src/docs/firmware/battery.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
prev: write-protect
next: false
---

# Disabling write protect via Battery

::: warning
This method requires opening your device. Be sure to use the correct tools to prevent hardware damange.
:::

<br>

## Step 1: Open the device and disconnect the battery

1. Power down your device. Close the lid and flip it over.
Expand Down
1 change: 0 additions & 1 deletion src/docs/firmware/compiling-coreboot.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Compiling Custom Firmware

## Cloning & Building ROMs
Expand Down
3 changes: 0 additions & 3 deletions src/docs/firmware/developer-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
prev: known-issues
next: write-protect
---

# Enabling developer mode

<br>

Enabling [developer mode](https://chromium.googlesource.com/chromiumos/docs/+/HEAD/developer_mode.md) the the first step to running an alternate OS on your chromebook!

::: danger
Expand Down
1 change: 0 additions & 1 deletion src/docs/firmware/flashing-firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
prev: about
next: ../installing/
---

# Flashing Custom Firmware

Refer to [this page](about) for an overview of both RW_LEGACY and UEFI.
Expand Down
7 changes: 1 addition & 6 deletions src/docs/firmware/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,12 @@
prev: false
next: supported-devices
---

# Flashing Custom Firmware

### Warning:

::: warning
::: danger
You are about to make **unofficial** changes to your device! This will likely **void any warranty.** We provide **zero warranty** if you encounter bugs, brick your device, lose your job because the alarm clock didn't go off, or if a thermonuclear war starts. **You are doing all changes at your own risk**!
:::

-------------

## Prerequisites
* Know your hardware
* Your CPU model and generation
Expand Down
1 change: 0 additions & 1 deletion src/docs/firmware/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
prev: system-info
next: developer-mode
---

# Known Issues

## Devices
Expand Down
1 change: 0 additions & 1 deletion src/docs/firmware/manually-flashing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Manually flashing roms

::: danger
Expand Down
1 change: 0 additions & 1 deletion src/docs/firmware/recovery-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
prev: developer-mode.md
next: false
---

# Recovery Mode

::: tip
Expand Down
1 change: 0 additions & 1 deletion src/docs/firmware/suzyq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
prev: write-protect
next: false
---

# Disabling write protect with a SuzyQable

::: tip
Expand Down
3 changes: 0 additions & 3 deletions src/docs/firmware/system-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
prev: supported-devices
next: known-issues
---

# Finding System Info

<br>

::: tip
Some of the following commands require [Developer mode](developer-mode).
:::
Expand Down
2 changes: 0 additions & 2 deletions src/docs/firmware/ventoy.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Installing Ventoy to a USB drive with chromeOS
Ventoy is a useful tool that allows you to have multiple OS installer images on a single drive. It is also the only way to properly create an installer for Windows using chromeOS.

<br>

## Backing up your drive
Before we begin, be sure to backup any data that may be on your USB drive as it will be erased during this process.

Expand Down
1 change: 0 additions & 1 deletion src/docs/firmware/write-protect.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
prev: developer-mode
next: about
---

# Disabling write protect

::: tip
Expand Down
2 changes: 0 additions & 2 deletions src/docs/installing/distros.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Linux distro-specific Configuration

<br>

## NixOS

- Enable and configure keyd (Example is cros-standard. Adjust as you need!)
Expand Down
2 changes: 0 additions & 2 deletions src/docs/installing/installing-macos.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Installing macOS

<br>

Before we begin, it's important to know whether your Chromebook is even supported:
- ARM/AMD CPUs are not supported.
- Intel Celeron / Pentium CPUs are not supported.
Expand Down
1 change: 0 additions & 1 deletion src/docs/installing/known-issues.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Known Issues


## Operating Systems

### Windows
Expand Down
1 change: 0 additions & 1 deletion src/docs/reverting/booting-recovery-usb.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
prev: making-recovery-usb
next: false
---

# Booting the Recovery USB

::: tip
Expand Down
1 change: 0 additions & 1 deletion src/docs/reverting/flashing-stock.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
prev: index.md
next: making-recovery-usb
---

# Flashing Stock Firmware

::: warning
Expand Down
3 changes: 0 additions & 3 deletions src/docs/reverting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
prev: false
next: flashing-stock
---

# Reverting to Stock chromeOS

<br>

::: warning
If your device has hit AUE (Auto Update Expiration), you will not be able to revert to chromeOS.
:::
Expand Down
1 change: 0 additions & 1 deletion src/docs/reverting/making-recovery-usb.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
prev: flashing-stock
next: booting-recovery-usb
---

# Making a Recovery USB

::: danger
Expand Down
3 changes: 0 additions & 3 deletions src/docs/terminology.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
prev: false
next: firmware/
---

# Terminology

<br>

| **Term** | **Description** |
| - | - |
| chrultrabook | A modified Chromebook/box designed to run Windows, Linux, or even macOS |
Expand Down
4 changes: 0 additions & 4 deletions src/docs/unbricking/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@
next: false
prev: false
---

# Unbricking

If you've found your way here, it's likely because you updated your firmware and, despite best efforts to minimize the possibility, something went wrong. Thankfully, most Chromebooks can be easily unbricked using cheap, readily available hardware: older Chromebooks using a ch341a USB programmer from Amazon/eBay/Alibaba (and many other sources), and newer (2017+) Chromebooks using a USB-C debug cable (aka Suzy-Q cable).

<br>

## Unbricking/Flashing with a ch341a USB programmer

### Requirements
Expand Down

0 comments on commit ae37bf2

Please sign in to comment.