Skip to content

Commit

Permalink
Restructure documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Reboot-Codes committed Sep 30, 2024
1 parent 529b333 commit 914dceb
Show file tree
Hide file tree
Showing 59 changed files with 8,549 additions and 11,796 deletions.
3 changes: 3 additions & 0 deletions core/applications/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CORE Applications

Clover relies on a few included applications that are used to provide expected functionality on a base system. Plus, there's a few extras to help you explore the possibilities.
File renamed without changes.
File renamed without changes.
10 changes: 10 additions & 0 deletions docs/docs/components/CORE/applications/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Applications

Clover relies on a few included applications that are used to provide expected functionality on a base system. Plus, there's a few extras to help you explore the possibilities.

## App Directory

| Name | Description | ID |
|-|-|-|
| Main | Provides the initial intent that Clover uses for expression replication, launching other applications, and handling user input. | `com.reboot-codes.clover.core.main` |
| Settings | More in-depth settings, but not as advanced as [Spanner](/docs/components/spanner/intro). | `com.reboot-codes.clover.core.settings` |
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Expression Replication

Use a sensor fusion model to replicate the user's expressions by manipulating other modules.

## Facial Expressions

In CORE, facial expressions can be replicated with a single [display](/docs/components/clover-hub/server/modman/modules/components/display), multiple displays, or by manipulating [Movement Components](/docs/components/clover-hub/server/modman/modules/components/movement)
3 changes: 3 additions & 0 deletions docs/docs/components/CORE/applications/main/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Main

Provides the initial intent that Clover uses for expression replication, launching other applications, and handling user input.
3 changes: 3 additions & 0 deletions docs/docs/components/CORE/applications/settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Settings

More in-depth settings, but not as advanced as [Spanner](/docs/components/spanner/intro).
3 changes: 3 additions & 0 deletions docs/docs/components/CORE/expression-packs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Expression Packs

Provides default dynamic expression animations for [The expression replicator](/docs/components/core/applications/main/expression-replication).
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/docs/components/CORE/modules/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Modules

Modules personally used by Reboot/Fitz that are designed to be extended by the users of Clover.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/docs/components/clover-hub/server/modman/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Display
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Components

Modules expose components which are registered as different types.

## Display

Display components are registered with modman, and are then passed onto the [renderer](/docs/components/clover-hub/server/renderer/intro) to receive frames over [EvtBuzz](/docs/components/clover-hub/server/evtbuzz/intro).

## Movement
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Movement
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Modules

Modules can comprise multiple components, and are responsible for exposing available components via a provided [API Key](/docs/components/clover-hub/server/evtbuzz/auth).
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
3 changes: 3 additions & 0 deletions docs/docs/components/clover-hub/tui/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
File renamed without changes.
15 changes: 15 additions & 0 deletions docs/docs/components/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Components

These are the core components that make up Clover's base.

## CloverHub

The Rust-based nerve centre for all communication between modules, their components, you, and configuration tools. It is built to be secure and performant, while allowing for flexible implementation for everything from spicing up your cosplay, to surgical body mods.

## CORE

Sensible default applications, lovingly designed parts, and dynamic expression packs to get you started. All parts are build using best-practices, and are considered to be fully supported and used as an immutable fallback when it comes to software.

## Spanner

Advanced configuration application that enables full control and composition of connected modules.
3 changes: 3 additions & 0 deletions docs/docs/components/spanner/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
3 changes: 3 additions & 0 deletions docs/docs/components/spanner/desktop/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
3 changes: 3 additions & 0 deletions docs/docs/components/spanner/desktop/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Desktop

The spanner desktop app is designed for easy configuration of Clover, including initial installation of clover.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/docs/components/spanner/lib/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
3 changes: 3 additions & 0 deletions docs/docs/components/spanner/lib/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# SpannerLib

Spanner lib is designed to provide a well documented and safe interface for connecting to Clover. It's written in rust and will eventually provide bindings for several languages.
6 changes: 2 additions & 4 deletions docs/docs/intro.md → docs/docs/guide/0-intro.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
sidebar_position: 1
---

# Introduction to CLOVER

CLOVER stands for:
Expand All @@ -13,3 +9,5 @@ Or, tl;dr, smart fursuit parts made for daily wear to help out your species dysp
Reads your expressions to change the position and display of animatronic fursuit parts, such as a head (with ears, a maw, and a custom LED display), tail, and paws.

It is currently very, very much a work in progress and is currently not ready for any sort of use, but you can follow along as you see fit.

With that out of the way, let's begin.
10 changes: 10 additions & 0 deletions docs/docs/guide/1-prerequisites/1-bill-of-materials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Bill of Materials

- A single board computer
- Optional, but HIGHLY suggested when using expression recreation: A Tensor Processing Unit (or something that can serve as one, a GPU on the SBC will work, otherwise [refer to Taurus' TPU support](https://taurus.reboot-codes.com/)).
- Optional, but suggested: Bluetooth Module (as long as the SBC has one and the OS has drivers for it, you'll be fine)
- Optional, but suggested: WLAN module (same as above, Hub uses the OS's IP stack)
- Body-safe Battery
- Reboot/Fitz mainly uses a belt-mounted LiPo battery pack (see: [CORE's modules](/docs/components/CORE/modules/intro)), but you can use just about anything that'll:
- Not explode when you go outside in the weather.
-
3 changes: 3 additions & 0 deletions docs/docs/guide/1-prerequisites/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
13 changes: 13 additions & 0 deletions docs/docs/guide/1-prerequisites/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Prerequisites

Clover is a very complex system, and you'll need to make a few decisions before you can begin to set it up.

[CORE](/docs/components/core/intro) is provided to give you a maintainer-supported platform to use and later expand upon. Or you can start with your own hardware, and reference this guide as you build and design your own components.

However, in general, you'll need:

- An SBC
- Some micro controllers (one per module)
- A couple of motors, servos, leds, etc.
- Access to a 3D printer.
- And a computer.
3 changes: 3 additions & 0 deletions docs/docs/guide/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
link:
type: doc
id: intro
10 changes: 8 additions & 2 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,19 @@ const config: Config = {
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
sidebarId: 'guideSidebar',
position: 'left',
label: 'Guide',
},
{
type: 'docSidebar',
sidebarId: 'docsSidebar',
position: 'left',
label: 'Docs',
},
{
href: `https://github.com/${organizationName}/${projectName}`,
label: 'GitHub',
label: 'Source',
position: 'right',
},
],
Expand Down
8 changes: 7 additions & 1 deletion docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,13 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
*/
const sidebars: SidebarsConfig = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
docsSidebar: [
{type: 'autogenerated', dirName: 'components'}
],

guideSidebar: [
{type: 'autogenerated', dirName: 'guide'}
],

// But you can create a sidebar manually
/*
Expand Down
11 changes: 10 additions & 1 deletion docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,18 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
to="/docs/guide/intro"
style={{ margin: "12px" }}
>
Get Started
</Link>
<Link
className="button button--secondary button--lg"
to="/docs/components/intro"
style={{ margin: "12px" }}
>
Read the Manual
</Link>
</div>
</div>
</header>
Expand Down
Loading

0 comments on commit 914dceb

Please sign in to comment.