v0.1.0-alpha.4: relay rebrand, request view, config/theming, docs

.github/workflows/ci-cd.yml

@@ -9,6 +9,7 @@ on:
     branches:
       - main
       - 'v[0-9]+.[0-9]+.[0-9]+'
+  workflow_dispatch:
 
 jobs:
   build-test:

docs/.vitepress/config.mts

@@ -0,0 +1,32 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Relay",
+  description: "docs for relay",
+  themeConfig: {
+    nav: [
+      { text: 'Home', link: '/' },
+    ],
+
+    sidebar: [
+      {
+        text: 'Quick Start',
+        items: [
+          { text: 'Installation', link: '/quick-start/installation' },
+          { text: 'First Steps', link: '/quick-start/first-steps' },
+        ]
+      },
+      {
+        text: 'Make Relay your own',
+        items: [
+          { text: 'Theme', link: '/customization/theme' },
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/yashranjan1/relay' }
+    ]
+  }
+})

docs/customization/theme.md

@@ -0,0 +1,28 @@
+# Theme Configuration
+
+Relay allows you to customize its visual appearance by updating your configuration file.
+
+## Changing the Theme
+
+You can change the active theme color by updating the `name` field under the `[Theme]` section in your configuration file.
+
+### Configuration Location
+The configuration file is formatted in **TOML** and is stored in your system's standard configuration directory, determined by Go's [`os.UserConfigDir()`](https://pkg.go.dev/os#UserConfigDir):
+
+* **Linux:** `~/.config/`
+* **macOS:** `~/Library/Application Support/`
+* **Windows:** `%AppData%`
+
+### Available Themes
+Set the `name` variable to one of the following supported options:
+
+* `"default"` — Default theme
+* `"cyberpunk"` — Cyberpunk theme
+* `"light-paper"` — Light Paper theme
+* `"forest"` — Forest theme
+
+### Example (`config.toml`)
+
+```toml
+[Theme]
+name = "forest"

docs/gifs/tapes/startup.tape

@@ -0,0 +1,66 @@
+# Where should we write the GIF?
+Output ../startup.gif
+
+# Set up a 1200x600 terminal with 46px font.
+Set FontSize 18
+Set Width 1920
+Set Height 1080
+
+Type "relay"
+
+Enter
+
+Sleep 100ms
+
+Type "a"
+
+Sleep 200ms
+
+Type "New Collection"
+
+Enter
+
+Sleep 200ms
+
+Enter
+
+Sleep 200ms
+
+Type "a"
+
+Type "New Endpoint"
+
+Enter
+
+Sleep 200ms
+
+Enter
+
+Sleep 200ms
+
+Ctrl+l
+
+Type "https://jsonplaceholder.typicode.com/users"
+
+Ctrl+S
+
+Ctrl+r
+
+Sleep 500ms
+
+Ctrl+d
+
+Sleep 50ms
+
+Ctrl+d
+
+Sleep 50ms
+
+Ctrl+d
+
+Sleep 50ms
+
+Enter
+
+Sleep 2
+

docs/index.md

@@ -0,0 +1,22 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "Relay"
+  text: "Ditch the Electron bloat with style"
+  tagline: Terminal-native API client built for developers who live in the CLI
+  actions:
+    - theme: brand
+      text: Quick start
+      link: /quick-start/installation
+
+features:
+  - title: Vim-like keybinds
+    details: Keep your hands on the keyboard. Relay is an extension of your editor, not another tool you have to tab into.
+  - title: Zero Lag
+    details: Built natively in Go with zero Electron bloat. 
+  - title: Built in the Open
+    details: No hidden paywalls, no enterprise-tier lockouts, and no telemetry tracking your requests.
+---
+

docs/package.json

@@ -0,0 +1,10 @@
+{
+  "devDependencies": {
+    "vitepress": "2.0.0-alpha.19"
+  },
+  "scripts": {
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview"
+  }
+}