From 40c233f7ca89ec62e7c4d2d4e57e6f2acb51f120 Mon Sep 17 00:00:00 2001 From: Ignaz Kevenaar Date: Mon, 22 Jul 2024 22:04:22 +0200 Subject: [PATCH] Remove unfinished coilpack docs --- docs/.vitepress/config.js | 9 --------- docs/coilpack.md | 21 --------------------- docs/coilpack/index.md | 25 ------------------------- docs/public/logo-coilpack.svg | 17 ----------------- 4 files changed, 72 deletions(-) delete mode 100644 docs/coilpack.md delete mode 100644 docs/coilpack/index.md delete mode 100644 docs/public/logo-coilpack.svg diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 49568ec..3a76cd2 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -17,7 +17,6 @@ module.exports = { nav: [ { text: "Guide", link: "/guide/introduction" }, { text: "Reference", link: "/reference/" }, - { text: "Coilpack", link: "/coilpack" }, { text: "GitHub", link: "https://github.com/ignazkevenaar/sparkplug" }, ], sidebar: [ @@ -54,14 +53,6 @@ module.exports = { { text: "US tail lights", link: "/guide/us-tail-lights" }, ], }, - { - text: "Coilpack", - items: [ - { text: "Creating a Config", link: "/" }, - { text: "Setting up Controls", link: "/" }, - { text: "Building and Uploading", link: "/" }, - ], - }, { text: "Extra Topics", items: [{ text: "Adding a filesystem", link: "/guide/littlefs" }], diff --git a/docs/coilpack.md b/docs/coilpack.md deleted file mode 100644 index 9df7542..0000000 --- a/docs/coilpack.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: home - -hero: - name: Coilpack - tagline: Web-based remote control for controlling Sparkplug lighting. - image: - src: /logo-coilpack.svg - alt: Logo image - actions: - - theme: brand - text: Get Started - link: /coilpack/ -features: - - title: Minimal configuration - details: Devide your lighting functionality into logical groups, with sensible defaults and good readability. Fading and blinking built-in. - - title: Extendible - details: Hook into events, write custom code, make it do the thing you want without fighting the library. Configuration and code on a per-model basis. - - title: Comes with a remote - details: Sparkplug runs on an ESP8266, and serves it's own remote control known as Coilpack. ---- diff --git a/docs/coilpack/index.md b/docs/coilpack/index.md deleted file mode 100644 index 082a78c..0000000 --- a/docs/coilpack/index.md +++ /dev/null @@ -1,25 +0,0 @@ -# Guide - -Coilpack is a Vue-based web application that serves as a remote for controlling Sparkplug lighting. - -It shares a bit of config between the hardware Sparkplug configuration, and the usable light controls for your browser. - -::: warning -Note: this software is currently under active development: anything can change at any time, API and UI must be considered unstable until we release version 1.0.0. -::: - -## Getting started - -### What is Coilpack? - -Coilpack is a Vue-based web application that serves as a remote for controlling Sparkplug lighting. It communicates to the Sparkplug Arduino sketch using [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API). - -Coilpack has configurable groups of controls for lights. - -### Installing dependencies - -### Adding config - -### Build and upload - -## Controls diff --git a/docs/public/logo-coilpack.svg b/docs/public/logo-coilpack.svg deleted file mode 100644 index 41f9ae7..0000000 --- a/docs/public/logo-coilpack.svg +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - - - - - - - - -