Skip to content

Commit 28fa9dd

Browse files
docs: configure Jekyll Just the Docs theme for GitHub Pages
Add Jekyll front matter to all markdown guides and create docs/_config.yml configured for GitHub Pages using the just-the-docs theme. Signed-off-by: night-slayer18 <samanuaia257@gmail.com>
1 parent b35a1b9 commit 28fa9dd

10 files changed

Lines changed: 69 additions & 0 deletions

File tree

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Welcome
4+
nav_order: 1
5+
permalink: /
6+
---
7+
18
# Runtime documentation
29

310
Documentation index for the Runtime monorepo. Start with the project [README](../README.md) for an overview and quick start.

docs/_config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Book settings
2+
title: "Runtime"
3+
description: "A family of terminal-native developer tools built with Go and Bubble Tea."
4+
theme: "just-the-docs"
5+
6+
# URL configuration (for GitHub Pages hosting)
7+
url: "https://night-slayer18.github.io"
8+
baseurl: "/runtime"
9+
10+
# Navigation settings
11+
nav_sort: "nav_order"
12+
13+
# Theme settings
14+
color_scheme: "dark"

docs/architecture.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Architecture
4+
nav_order: 2
5+
---
6+
17
# Architecture
28

39
Runtime is a Go monorepo of independently versioned modules: five applications under `apps/` and eleven shared packages under `packages/`. This document describes how the pieces fit together.

docs/configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Configuration & Themes
4+
nav_order: 3
5+
---
6+
17
# Configuration
28

39
Every Runtime application shares one configuration model, provided by the `packages/config` module. Configuration is per-app, stored as JSON in the platform's standard config directory, and applied on startup. The schema is compatible across all apps, so knowledge transfers between them.

docs/grid.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Grid (Tabular)
4+
nav_order: 4
5+
---
6+
17
# runtime-grid
28

39
Tabular data workbench. Grid imports a data file into a virtualized table you can navigate and filter entirely from the keyboard.

docs/prism.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Prism (Documents)
4+
nav_order: 5
5+
---
6+
17
# runtime-prism
28

39
Structured document explorer. Prism parses a document into a navigable tree you can expand, collapse, and search by key or value.

docs/pulse.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Pulse (Logs)
4+
nav_order: 6
5+
---
6+
17
# runtime-pulse
28

39
Log exploration and analysis. Pulse tails a log file live, filters lines by pattern, and groups similar messages so you can spot recurring errors.

docs/releasing.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Versioning & Releases
4+
nav_order: 9
5+
---
6+
17
# Releasing
28

39
Every module in the monorepo is versioned and released **independently**. Releasing one app never requires touching another. This guide covers cutting a release with `scripts/version.sh` and what the release pipeline produces.

docs/strata.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Strata (Database)
4+
nav_order: 7
5+
---
6+
17
# runtime-strata
28

39
Database exploration and administration. Strata connects to a database from a single connection string, reads its schema, and renders query results in a virtualized table.

docs/vault.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Vault (Secrets)
4+
nav_order: 8
5+
---
6+
17
# runtime-vault
28

39
Secrets and configuration explorer. Vault inspects, validates, and decodes secret artifacts, showing only non-sensitive metadata — secret values are always masked.

0 commit comments

Comments
 (0)