-
----
-
+***
First of all, thank you for your interest in contributing to KibaTV! We welcome contributions from developers, designers, and documentation enthusiasts.
-
----
-
+***
## Developer Quick Start
To begin contributing to the KibaTV build system or customization hooks, follow these steps:
@@ -29,8 +25,16 @@ To begin contributing to the KibaTV build system or customization hooks, follow
docker run --rm --privileged -v "$PWD:/w" -e RUN_NUM=local debian:trixie /w/build.sh
```
----
+```
+```
+
+```
+
+```
+
+````
+***
## How to Contribute
### Reporting Bugs
@@ -73,9 +77,7 @@ We love new ideas! Please open an issue to discuss significant features before i
- **Branching:** Work on a descriptive branch name (e.g., `feature/custom-icons`).
- **Commits:** Follow conventional commit messages.
- **Testing:** Always run a local build (see above) to verify your changes don't break the ISO generation.
-
----
-
+***
## Project Structure
| Directory | Purpose |
@@ -88,9 +90,7 @@ We love new ideas! Please open an issue to discuss significant features before i
> [!TIP]
> Most of the system customization logic resides in the **`build.sh`** generation block within **`.github/workflows/kiba.yml`**. Look for the `cat > config/hooks/live/...` sections.
-
----
-
+***
## Automated Triage
We use automated workflows to help manage the project:
@@ -98,17 +98,15 @@ We use automated workflows to help manage the project:
- **Labeler:** Automatically labels PRs based on changed files.
- **Issue Triage:** Auto-labels new issues based on keywords (`bug`, `feature`, etc.).
- **Stale:** Automatically closes inactive issues after a period of time.
-
----
-
+***
## License
By contributing to KibaTV, you agree that your contributions will be licensed under the **MIT License**.
-
----
-
+***
## Related Reading
-- [**Build System**](./build-system.md)
-- [**Architecture**](./architecture.md)
-- [**FAQ**](./faq.md)
+- [**Build System**](./docs/build-system.md)
+- [**Architecture**](./docs/architecture.md)
+- [**FAQ**](./docs/faq.md)
+```bash
+````
diff --git a/README.md b/README.md
index b9cbb611..aa1fefd4 100644
--- a/README.md
+++ b/README.md
@@ -27,9 +27,7 @@ KibaOS is a lightweight Linux distribution built on **Debian 13 (Trixie)** with
-
----
-
+***
This document provides a technical overview of the KibaTV architectural stack, from the base system to the final user-facing components.
-
----
-
+***
## Table of Contents
- [System Stack](#system-stack)
@@ -36,7 +32,7 @@ This document provides a technical overview of the KibaTV architectural stack, f
---
-## System Stack
+## System Stack (system-stack) (system-stack)
```mermaid
graph TD
diff --git a/docs/build-system.md b/docs/build-system.md
index cd15877c..70f25fde 100644
--- a/docs/build-system.md
+++ b/docs/build-system.md
@@ -9,13 +9,9 @@
-
----
-
+***
KibaTV utilizes a highly automated CI/CD pipeline to generate reproducible ISO images. This document details the infrastructure, build stages, and customization hooks used in the process.
-
----
-
+***
## Build Pipeline
````mermaid
@@ -28,18 +24,14 @@ graph LR
F --> G[ISO Generation]
G --> H[Verification]
H --> I[Upload to SourceForge]
-```bash
-
----
-
+```
+***
## Infrastructure
- **Orchestration:** **GitHub Actions** (`.github/workflows/kiba.yml`) manages the build lifecycle.
- **Environment:** Builds run inside a **Debian Trixie** Docker container to ensure environment consistency.
- **Backend:** **live-build (lb)** is used to assemble the Debian-based live system.
-
----
-
+***
## Customization Hooks
KibaTV relies on a series of chroot and binary hooks to apply its unique features. These hooks are dynamically created by the GitHub Action workflow before the build starts.
@@ -67,9 +59,7 @@ _Executed on the final ISO filesystem._
| :------------------------------------------ | :----------------------------------------------------------------------------- |
| **`0010-squashfs-compression.hook.binary`** | Repacks the SquashFS with maximum Zstd level 19 compression. |
| **`0020-bootloader-branding.hook.binary`** | Patches `grub.cfg` to provide branded and beginner-friendly boot menu options. |
-
----
-
+***
## Local Development
You can reproduce the KibaTV build environment locally on any Linux machine with Docker.
@@ -90,15 +80,13 @@ docker run --rm --privileged \
-e RUN_NUM=local \
debian:trixie \
/w/build.sh
-```bash
+```
_Note: The `build.sh` script is generated by the GitHub Actions workflow. Ensure you have at least 15GB of free space._
> [!NOTE]
> The `build.sh` script is the entry point that orchestrates `lb config` and `lb build`. It is generated by the CI workflow, but you can find its logic in `.github/workflows/kiba.yml`.
-
----
-
+***
## Verification & Delivery
After the build completes, the pipeline performs several verification steps:
@@ -106,9 +94,7 @@ After the build completes, the pipeline performs several verification steps:
1. **Grep Logs:** Ensures `cachyos`, `starship`, and other critical components were successfully processed.
2. **Checksum:** Generates a SHA256 hash of the final ISO.
3. **Upload:** Automatically pushes the ISO to **SourceForge** if the build was triggered from the `main` branch.
-
----
-
+***
## Related Reading
- [**Architecture**](./architecture.md)
diff --git a/docs/contributing.md b/docs/contributing.md
index a1c6979f..5d88a0d5 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -8,13 +8,9 @@
-
----
-
+***
First of all, thank you for your interest in contributing to KibaTV! We welcome contributions from developers, designers, and documentation enthusiasts.
-
----
-
+***
## Developer Quick Start
To begin contributing to the KibaTV build system or customization hooks, follow these steps:
@@ -29,8 +25,16 @@ To begin contributing to the KibaTV build system or customization hooks, follow
docker run --rm --privileged -v "$PWD:/w" -e RUN_NUM=local debian:trixie /w/build.sh
```
----
+```
+```
+
+```
+
+```
+
+````
+***
## How to Contribute
### Reporting Bugs
@@ -73,9 +77,7 @@ We love new ideas! Please open an issue to discuss significant features before i
- **Branching:** Work on a descriptive branch name (e.g., `feature/custom-icons`).
- **Commits:** Follow conventional commit messages.
- **Testing:** Always run a local build (see above) to verify your changes don't break the ISO generation.
-
----
-
+***
## Project Structure
| Directory | Purpose |
@@ -88,9 +90,7 @@ We love new ideas! Please open an issue to discuss significant features before i
> [!TIP]
> Most of the system customization logic resides in the **`build.sh`** generation block within **`.github/workflows/kiba.yml`**. Look for the `cat > config/hooks/live/...` sections.
-
----
-
+***
## Automated Triage
We use automated workflows to help manage the project:
@@ -98,17 +98,15 @@ We use automated workflows to help manage the project:
- **Labeler:** Automatically labels PRs based on changed files.
- **Issue Triage:** Auto-labels new issues based on keywords (`bug`, `feature`, etc.).
- **Stale:** Automatically closes inactive issues after a period of time.
-
----
-
+***
## License
By contributing to KibaTV, you agree that your contributions will be licensed under the **MIT License**.
-
----
-
+***
## Related Reading
-- [**Build System**](./build-system.md)
-- [**Architecture**](./architecture.md)
-- [**FAQ**](./faq.md)
+- [**Build System**](./docs/build-system.md)
+- [**Architecture**](./docs/architecture.md)
+- [**FAQ**](./docs/faq.md)
+```bash
+````
diff --git a/docs/faq.md b/docs/faq.md
index 2011b6c4..1a8740aa 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -7,9 +7,7 @@
-
----
-
+***
KibaTV is built with a "Privacy by Design" philosophy. We go beyond standard security practices to ensure compliance with modern digital safety laws and to minimize the system's attack surface.
-
----
-
+***
## California Age-Appropriate Design Code (AB 2273)
To comply with the California Age-Appropriate Design Code Act, KibaTV features a custom **Age Verification** module within the **Calamares** installer.
diff --git a/docs/software-management.md b/docs/software-management.md
index a4173bb0..3eee9113 100644
--- a/docs/software-management.md
+++ b/docs/software-management.md
@@ -9,13 +9,9 @@
-
----
-
+***
KibaTV provides a dual-layered approach to software management: a beginner-friendly graphical store and a powerful, modern command-line interface.
-
----
-
+***
## KibaStore (Bazaar)
The primary graphical interface for managing software in KibaTV is **KibaStore**, which is a native implementation of **Bazaar**.
@@ -89,10 +85,8 @@ flatpak search 
-
----
-
+***
KibaTV is built with a focus on "modern simplicity." This document details the visual identity, the Dracula-inspired aesthetic, and the highly optimized terminal experience.
-
----
-
+***
## Table of Contents
- [Visual Identity](#visual-identity)
@@ -45,15 +41,15 @@ The KibaTV aesthetic is built around the official **Dracula** color palette, pro
### Color Palette
-| Color | Hex | Role |
-| :--------------- | :-------- | :------------------------------------------------------- |
-| **Background** | `#282a36` | Primary window and desktop background |
-| **Current Line** | `#44475a` | Highlight and secondary background |
-| **Foreground** | `#f8f8f2` | Primary text color |
-| **Comment** | `#6272a4` | Secondary text and disabled elements |
-| **Purple** | `#bd93f9` | Accent color, selection background, and primary branding |
-| **Pink** | `#ff79c6` | Selection foreground and highlights |
-| **Green** | `#50fa7b` | Success states and active terminal elements |
+| Color | Hex | Role |
+| :--------------- | :------------------ | :------------------------------------------------------- |
+| **Background** | `\#`\hex 0x282a36`` | Primary window and desktop background |
+| **Current Line** | `\#`\hex #44475a`` | Highlight and secondary background |
+| **Foreground** | `\#`\#f8f8f2`` | Primary text color |
+| **Comment** | `\#`\#6272a4`` | Secondary text and disabled elements |
+| **Purple** | `\#`\#bd93f9`` | Accent color, selection background, and primary branding |
+| **Pink** | `\#`\#ff79c6`` | Selection foreground and highlights |
+| **Green** | `\#`\#50fa7b`` | Success states and active terminal elements |
### Look and Feel
diff --git a/scripts/save_release_notes.sh b/scripts/save_release_notes.sh
index 4a24af5b..06e07841 100755
--- a/scripts/save_release_notes.sh
+++ b/scripts/save_release_notes.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
# License: MIT
#
# Copyright (c) 2025 WolfTech Innovations
@@ -34,9 +34,9 @@ save_release_notes() {
exit 1
fi
- local release_id; release_id="${1:-${RELEASE_ID:-}}"
- local github_token; github_token="${GH_TOKEN:-}"
- local repo; repo="${GITHUB_REPOSITORY:-}"
+ release_id; release_id="${1:-${RELEASE_ID:-}}"
+ github_token; github_token="${GH_TOKEN:-}"
+ repo; repo="${GITHUB_REPOSITORY:-}"
if [ -z "$release_id" ]; then
printf "Error: RELEASE_ID environment variable or argument is required.\n" >&2
@@ -61,21 +61,21 @@ save_release_notes() {
# Y: Last digit of year
# M: Month (1-C for 1-12)
- local dd h_val y_val m_val vars
+ dd h_val y_val m_val vars
vars=$(date "+%d %-H %y %-m")
read -r dd h_val y_val m_val <
-
+
-
+
-
+
-
+
-***
+
+---
+
KibaTV utilizes a highly automated CI/CD pipeline to generate reproducible ISO images. This document details the infrastructure, build stages, and customization hooks used in the process.
-***
+
+---
+
## Build Pipeline
````mermaid
@@ -24,14 +28,18 @@ graph LR
F --> G[ISO Generation]
G --> H[Verification]
H --> I[Upload to SourceForge]
-```
-***
+```bash
+
+---
+
## Infrastructure
- **Orchestration:** **GitHub Actions** (`.github/workflows/kiba.yml`) manages the build lifecycle.
- **Environment:** Builds run inside a **Debian Trixie** Docker container to ensure environment consistency.
- **Backend:** **live-build (lb)** is used to assemble the Debian-based live system.
-***
+
+---
+
## Customization Hooks
KibaTV relies on a series of chroot and binary hooks to apply its unique features. These hooks are dynamically created by the GitHub Action workflow before the build starts.
@@ -59,7 +67,9 @@ _Executed on the final ISO filesystem._
| :------------------------------------------ | :----------------------------------------------------------------------------- |
| **`0010-squashfs-compression.hook.binary`** | Repacks the SquashFS with maximum Zstd level 19 compression. |
| **`0020-bootloader-branding.hook.binary`** | Patches `grub.cfg` to provide branded and beginner-friendly boot menu options. |
-***
+
+---
+
## Local Development
You can reproduce the KibaTV build environment locally on any Linux machine with Docker.
@@ -73,20 +83,22 @@ You can reproduce the KibaTV build environment locally on any Linux machine with
### Build Steps
```bash
-git clone [[Kiba](https://github.com/WolfTech-Innovations/Kiba)]([Kiba](https://github.com/WolfTech-Innovations/Kiba))
+git clone [https://github.com/WolfTech-Innovations/Kiba](https://github.com/WolfTech-Innovations/Kiba)
cd Kiba
docker run --rm --privileged \
-v "$PWD:/w" \
-e RUN_NUM=local \
debian:trixie \
/w/build.sh
-```
+```bash
_Note: The `build.sh` script is generated by the GitHub Actions workflow. Ensure you have at least 15GB of free space._
> [!NOTE]
> The `build.sh` script is the entry point that orchestrates `lb config` and `lb build`. It is generated by the CI workflow, but you can find its logic in `.github/workflows/kiba.yml`.
-***
+
+---
+
## Verification & Delivery
After the build completes, the pipeline performs several verification steps:
@@ -94,7 +106,9 @@ After the build completes, the pipeline performs several verification steps:
1. **Grep Logs:** Ensures `cachyos`, `starship`, and other critical components were successfully processed.
2. **Checksum:** Generates a SHA256 hash of the final ISO.
3. **Upload:** Automatically pushes the ISO to **SourceForge** if the build was triggered from the `main` branch.
-***
+
+---
+
## Related Reading
- [**Architecture**](./architecture.md)
diff --git a/docs/contributing.md b/docs/contributing.md
index 0b9a2093..8dec6afb 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -8,28 +8,34 @@
-***
+
+---
+
First of all, thank you for your interest in contributing to KibaTV! We welcome contributions from developers, designers, and documentation enthusiasts.
-***
+
+---
+
## Developer Quick Start
To begin contributing to the KibaTV build system or customization hooks, follow these steps:
-1. **Fork the Repo:** Create your own fork of [WolfTech-Innovations/Kiba](<[Kiba](https://github.com/WolfTech-Innovations/Kiba)>).
+1. **Fork the Repo:** Create your own fork of [WolfTech-Innovations/Kiba](https://github.com/WolfTech-Innovations/Kiba).
2. **Setup Environment:** Ensure you have **Docker** installed on a Linux host.
3. **Local Build:** Run a local build to ensure your environment is working:
-```bash
+ ```bash
git clone [https://github.com/YOUR_USERNAME/Kiba](https://github.com/YOUR_USERNAME/Kiba)
cd Kiba
docker run --rm --privileged -v "$PWD:/w" -e RUN_NUM=local debian:trixie /w/build.sh
-bash
-***
+```bash
+
+---
+
## How to Contribute
### Reporting Bugs
-If you find a bug, please open an issue on our [GitHub repository]([Kiba](https://github.com/WolfTech-Innovations/Kiba)/issues). Provide as much detail as possible, including:
+If you find a bug, please open an issue on our [GitHub repository](https://github.com/WolfTech-Innovations/Kiba/issues). Provide as much detail as possible, including:
- A clear and descriptive title.
- Steps to reproduce the bug.
@@ -67,7 +73,9 @@ We love new ideas! Please open an issue to discuss significant features before i
- **Branching:** Work on a descriptive branch name (e.g., `feature/custom-icons`).
- **Commits:** Follow conventional commit messages.
- **Testing:** Always run a local build (see above) to verify your changes don't break the ISO generation.
-***
+
+---
+
## Project Structure
| Directory | Purpose |
@@ -80,7 +88,9 @@ We love new ideas! Please open an issue to discuss significant features before i
> [!TIP]
> Most of the system customization logic resides in the **`build.sh`** generation block within **`.github/workflows/kiba.yml`**. Look for the `cat > config/hooks/live/...` sections.
-***
+
+---
+
## Automated Triage
We use automated workflows to help manage the project:
@@ -88,17 +98,17 @@ We use automated workflows to help manage the project:
- **Labeler:** Automatically labels PRs based on changed files.
- **Issue Triage:** Auto-labels new issues based on keywords (`bug`, `feature`, etc.).
- **Stale:** Automatically closes inactive issues after a period of time.
-***
+
+---
+
## License
By contributing to KibaTV, you agree that your contributions will be licensed under the **MIT License**.
-***
-## Related Reading
-- [**Build System**](./docs/build-system.md)
-- [**Architecture**](./docs/architecture.md)
-- [**FAQ**](./docs/faq.md)
-bash
+---
+
+## Related Reading
-`
-```
+- [**Build System**](./build-system.md)
+- [**Architecture**](./architecture.md)
+- [**FAQ**](./faq.md)
diff --git a/docs/faq.md b/docs/faq.md
index 1a8740aa..2011b6c4 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -7,7 +7,9 @@
-***
+
+---
+
KibaTV is built with a "Privacy by Design" philosophy. We go beyond standard security practices to ensure compliance with modern digital safety laws and to minimize the system's attack surface.
-***
+
+---
+
## California Age-Appropriate Design Code (AB 2273)
To comply with the California Age-Appropriate Design Code Act, KibaTV features a custom **Age Verification** module within the **Calamares** installer.
diff --git a/docs/software-management.md b/docs/software-management.md
index 3eee9113..a4173bb0 100644
--- a/docs/software-management.md
+++ b/docs/software-management.md
@@ -9,9 +9,13 @@
-***
+
+---
+
KibaTV provides a dual-layered approach to software management: a beginner-friendly graphical store and a powerful, modern command-line interface.
-***
+
+---
+
## KibaStore (Bazaar)
The primary graphical interface for managing software in KibaTV is **KibaStore**, which is a native implementation of **Bazaar**.
@@ -85,8 +89,10 @@ flatpak search
-***
+
+---
+
KibaTV is built with a focus on "modern simplicity." This document details the visual identity, the Dracula-inspired aesthetic, and the highly optimized terminal experience.
-***
+
+---
+
## Table of Contents
- [Visual Identity](#visual-identity)
@@ -41,15 +45,15 @@ The KibaTV aesthetic is built around the official **Dracula** color palette, pro
### Color Palette
-| Color | Hex | Role |
-| :--------------- | :------------------ | :------------------------------------------------------- |
+| Color | Hex | Role |
+| :--------------- | :----------------- | :------------------------------------------------------- |
| **Background** | `\#`\hex 0x282a36`` | Primary window and desktop background |
-| **Current Line** | `\#`\hex #44475a`` | Highlight and secondary background |
-| **Foreground** | `\#`\#f8f8f2`` | Primary text color |
-| **Comment** | `\#`\#6272a4`` | Secondary text and disabled elements |
-| **Purple** | `\#`\#bd93f9`` | Accent color, selection background, and primary branding |
-| **Pink** | `\#`\#ff79c6`` | Selection foreground and highlights |
-| **Green** | `\#`\#50fa7b`` | Success states and active terminal elements |
+| **Current Line** | `\#`\hex #44475a`` | Highlight and secondary background |
+| **Foreground** | `\#`\#f8f8f2`` | Primary text color |
+| **Comment** | `\#`\#6272a4`` | Secondary text and disabled elements |
+| **Purple** | `\#`\#bd93f9`` | Accent color, selection background, and primary branding |
+| **Pink** | `\#`\#ff79c6`` | Selection foreground and highlights |
+| **Green** | `\#`\#50fa7b`` | Success states and active terminal elements |
### Look and Feel
diff --git a/scripts/save_release_notes.sh b/scripts/save_release_notes.sh
index 835f1dc2..33590ae4 100755
--- a/scripts/save_release_notes.sh
+++ b/scripts/save_release_notes.sh
@@ -21,7 +21,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
-set -euo pipefail
+set -eu
trap 'printf "Interrupted. Cleaning up...\n" >&2' INT TERM
@@ -29,76 +29,75 @@ trap 'printf "Interrupted. Cleaning up...\n" >&2' INT TERM
# Convention: NTE-DDHYM.md
save_release_notes() {
- if [[ "$#" -ne 1 && -z "${RELEASE_ID:-}" ]]; then
+ if [ "$#" -ne 1 ] && [ -z "${RELEASE_ID:-}" ]; then
printf "Usage: %s [release_id]\n" "$0" >&2
exit 1
fi
- local release_id="${1:-${RELEASE_ID:-}}"
- local github_token="${GH_TOKEN:-}"
- local repo="${GITHUB_REPOSITORY:-}"
+ release_id="${1:-${RELEASE_ID:-}}"
+ github_token="${GH_TOKEN:-}"
+ repo="${GITHUB_REPOSITORY:-}"
- if [[ -z "$release_id" ]; then
+ if [ -z "$release_id" ]; then
printf "Error: RELEASE_ID environment variable or argument is required.\n" >&2
return 1
fi
- if [[ -z "$github_token" ]; then
+ if [ -z "$github_token" ]; then
printf "Error: GH_TOKEN environment variable is required.\n" >&2
return 1
fi
- if [[ -z "$repo" ]; then
+ if [ -z "$repo" ]; then
printf "Error: GITHUB_REPOSITORY environment variable is required.\n" >&2
return 1
fi
# 1. Generate filename: NTE-DDHYM
# Optimization: Single date call reduces process spawning.
- # Using Bash string manipulation instead of cut/printf.
# DD: Day of month (01-31)
# H: Hour of day (0-N for 0-23)
# Y: Last digit of year
# M: Month (1-C for 1-12)
- local dd h_val y_val m_val vars
- vars=$(date "+%d %-H %y %-m")
+ vars=$(date "+%d %H %y %m")
+ dd=$(echo "$vars" | cut -d' ' -f1)
+ h_val=$(echo "$vars" | cut -d' ' -f2)
+ y_val=$(echo "$vars" | cut -d' ' -f3)
+ m_val=$(echo "$vars" | cut -d' ' -f4)
- read -r dd h_val y_val m_val <