Skip to content

Commit

Permalink
wiki: Initial commit
Browse files Browse the repository at this point in the history
Change-Id: Ia7a32b0d89914ed6d6ed822b42727cc0d4669c97
  • Loading branch information
neroices committed Dec 20, 2024
0 parents commit 8dff656
Show file tree
Hide file tree
Showing 12 changed files with 2,950 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
dist
cache
22 changes: 22 additions & 0 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { defineConfig } from "vitepress";

export default defineConfig({
title: "WitAqua Wiki",
description: "WitAqua Wiki",
themeConfig: {
nav: [{ text: "Website", link: "https://witaqua.org" }],

sidebar: [
{
text: "Home",
collapsed: false,
items: [{ text: "Building WitAqua", link: "/developers/building" }],
},
],

socialLinks: [
{ icon: "github", link: "https://github.com/WitAqua" },
{ icon: "x", link: "https://x.com/WitAquaROM" },
],
},
});
17 changes: 17 additions & 0 deletions .vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// https://vitepress.dev/guide/custom-theme
import { h } from 'vue'
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
import './style.css'

export default {
extends: DefaultTheme,
Layout: () => {
return h(DefaultTheme.Layout, null, {
// https://vitepress.dev/guide/extending-default-theme#layout-slots
})
},
enhanceApp({ app, router, siteData }) {
// ...
}
} satisfies Theme
139 changes: 139 additions & 0 deletions .vitepress/theme/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
/**
* Customize default theme styling by overriding CSS variables:
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
*/

/**
* Colors
*
* Each colors have exact same color scale system with 3 levels of solid
* colors with different brightness, and 1 soft color.
*
* - `XXX-1`: The most solid color used mainly for colored text. It must
* satisfy the contrast ratio against when used on top of `XXX-soft`.
*
* - `XXX-2`: The color used mainly for hover state of the button.
*
* - `XXX-3`: The color for solid background, such as bg color of the button.
* It must satisfy the contrast ratio with pure white (#ffffff) text on
* top of it.
*
* - `XXX-soft`: The color used for subtle background such as custom container
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
* on top of it.
*
* The soft color must be semi transparent alpha channel. This is crucial
* because it allows adding multiple "soft" colors on top of each other
* to create a accent, such as when having inline code block inside
* custom containers.
*
* - `default`: The color used purely for subtle indication without any
* special meanings attached to it such as bg color for menu hover state.
*
* - `brand`: Used for primary brand colors, such as link text, button with
* brand theme, etc.
*
* - `tip`: Used to indicate useful information. The default theme uses the
* brand color for this by default.
*
* - `warning`: Used to indicate warning to the users. Used in custom
* container, badges, etc.
*
* - `danger`: Used to show error, or dangerous message to the users. Used
* in custom container, badges, etc.
* -------------------------------------------------------------------------- */

:root {
--vp-c-default-1: var(--vp-c-gray-1);
--vp-c-default-2: var(--vp-c-gray-2);
--vp-c-default-3: var(--vp-c-gray-3);
--vp-c-default-soft: var(--vp-c-gray-soft);

--vp-c-brand-1: var(--vp-c-indigo-1);
--vp-c-brand-2: var(--vp-c-indigo-2);
--vp-c-brand-3: var(--vp-c-indigo-3);
--vp-c-brand-soft: var(--vp-c-indigo-soft);

--vp-c-tip-1: var(--vp-c-brand-1);
--vp-c-tip-2: var(--vp-c-brand-2);
--vp-c-tip-3: var(--vp-c-brand-3);
--vp-c-tip-soft: var(--vp-c-brand-soft);

--vp-c-warning-1: var(--vp-c-yellow-1);
--vp-c-warning-2: var(--vp-c-yellow-2);
--vp-c-warning-3: var(--vp-c-yellow-3);
--vp-c-warning-soft: var(--vp-c-yellow-soft);

--vp-c-danger-1: var(--vp-c-red-1);
--vp-c-danger-2: var(--vp-c-red-2);
--vp-c-danger-3: var(--vp-c-red-3);
--vp-c-danger-soft: var(--vp-c-red-soft);
}

/**
* Component: Button
* -------------------------------------------------------------------------- */

:root {
--vp-button-brand-border: transparent;
--vp-button-brand-text: var(--vp-c-white);
--vp-button-brand-bg: var(--vp-c-brand-3);
--vp-button-brand-hover-border: transparent;
--vp-button-brand-hover-text: var(--vp-c-white);
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
--vp-button-brand-active-border: transparent;
--vp-button-brand-active-text: var(--vp-c-white);
--vp-button-brand-active-bg: var(--vp-c-brand-1);
}

/**
* Component: Home
* -------------------------------------------------------------------------- */

:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(
120deg,
#bd34fe 30%,
#41d1ff
);

--vp-home-hero-image-background-image: linear-gradient(
-45deg,
#bd34fe 50%,
#47caff 50%
);
--vp-home-hero-image-filter: blur(44px);
}

@media (min-width: 640px) {
:root {
--vp-home-hero-image-filter: blur(56px);
}
}

@media (min-width: 960px) {
:root {
--vp-home-hero-image-filter: blur(68px);
}
}

/**
* Component: Custom Block
* -------------------------------------------------------------------------- */

:root {
--vp-custom-block-tip-border: transparent;
--vp-custom-block-tip-text: var(--vp-c-text-1);
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
}

/**
* Component: Algolia
* -------------------------------------------------------------------------- */

.DocSearch {
--docsearch-primary-color: var(--vp-c-brand-1) !important;
}

83 changes: 83 additions & 0 deletions assets/witaqua.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 49 additions & 0 deletions developers/building.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Prerequisites
Before you begin, it is essential to ensure that your machine meets the necessary requirements and has the required dependencies installed.

## Initialize the Repository

Create a directory for your Android source code:

```bash
mkdir ~/witaqua
cd ~/witaqua
```

Now initialize the repo:

```bash
repo init -u https://github.com/WitAqua/manifest.git -b 15 --git-lfs
```

## Sync the Repository

Sync the repository to download the source code:

```bash
repo sync
```
::: info
This can take several hours depending on your internet connection.
:::
## Set Up the Build Environment

Before you can build, you'll need to set up the environment for the build.

```bash
. build/envsetup.sh
```

## Choose the Device

```bash
breakfast <codename>
```

## Build the Source

Start the build process:

```bash
brunch <codename>
```
63 changes: 63 additions & 0 deletions devices/bluejay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Google Pixel 6a
prev: false
next: false
---

# Installation Guide for Google Pixel 6a <Badge type="info" text="bluejay" />
::: warning
Keep in mind that flashing a custom ROM will erase all data on your device, including apps, settings, and system files, effectively restoring it to a factory-like state. Double-check that your backups are complete and accessible before moving forward.
:::

## Enter Fastboot Mode
- First, completely power off your device.
- To enter Fastboot mode, press and hold the `Power` and `Volume Down` buttons simultaneously. Keep holding them until the Fastboot screen appears.

## Connect Your Device to the PC
- Use a reliable USB cable to connect your device to the PC.
- Ensure that your PC has the necessary drivers installed for your device.

## Verify the Device
- Open a terminal or command prompt on your PC and run the following command:
```bash
fastboot devices
```
- If your device is detected, it will show a unique identifier followed by the word "fastboot." Example:
```
ABC12345XYZ fastboot
```
- If nothing appears, ensure Fastboot is properly configured on your PC, check the USB connection, and verify that the device is in Fastboot mode.

## Flash Necessary Images
::: info
Ensure the image file (`boot.img`, `dtbo.img`, and `vendor_boot.img`) is in the same directory as your terminal/command prompt. Then, execute the following command:
:::
```bash
fastboot flash boot boot.img
fastboot flash dtbo dtbo.img
fastboot flash vendor_boot vendor_boot.img
```
::: info
After flashing, do not boot into the system yet. Instead, reboot directly into recovery mode.
:::

## Perform a Format Data
::: warning
Formatting data will erase all user files and settings. Ensure you’ve backed up your data before proceeding.
:::
- Navigate to the "Wipe" or "Format Data" option in the recovery menu.
- Select **Factory Reset** or **Format Data**. Confirm the action.

## Install the ROM
- Go to `Main Menu` > `Apply Update` > `Apply from ADB`.
- On your PC, navigate to the directory where the ROM file is saved.
- Open a terminal in that directory.
- Enter the sideload command:
```bash
adb sideload <filename>.zip
```
::: info
This can take several minutes.
:::
- After the installation is complete, return to the main menu of the recovery.
- Select `Reboot` > `System`.
9 changes: 9 additions & 0 deletions devices/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "List of Supported Devices"
prev: false
next: false
---
# List of Supported Devices

## Google
- [Pixel 6a](/devices/bluejay) <Badge type="info" text="bluejay" />
Loading

0 comments on commit 8dff656

Please sign in to comment.