diff --git a/docs/docs/components/intro.md b/docs/docs/components/00-intro.md similarity index 100% rename from docs/docs/components/intro.md rename to docs/docs/components/00-intro.md diff --git a/docs/docs/components/CORE/_category_.yaml b/docs/docs/components/01-clover-hub/_category_.yaml similarity index 100% rename from docs/docs/components/CORE/_category_.yaml rename to docs/docs/components/01-clover-hub/_category_.yaml diff --git a/docs/docs/components/clover-hub/cli.md b/docs/docs/components/01-clover-hub/cli.md similarity index 100% rename from docs/docs/components/clover-hub/cli.md rename to docs/docs/components/01-clover-hub/cli.md diff --git a/docs/docs/components/clover-hub/intro.md b/docs/docs/components/01-clover-hub/intro.md similarity index 100% rename from docs/docs/components/clover-hub/intro.md rename to docs/docs/components/01-clover-hub/intro.md diff --git a/docs/docs/components/CORE/applications/_category_.yaml b/docs/docs/components/01-clover-hub/server/_category_.yaml similarity index 100% rename from docs/docs/components/CORE/applications/_category_.yaml rename to docs/docs/components/01-clover-hub/server/_category_.yaml diff --git a/docs/docs/components/CORE/applications/applib/_category_.yaml b/docs/docs/components/01-clover-hub/server/appd/_category_.yaml similarity index 100% rename from docs/docs/components/CORE/applications/applib/_category_.yaml rename to docs/docs/components/01-clover-hub/server/appd/_category_.yaml diff --git a/docs/docs/components/01-clover-hub/server/appd/application-manifest.md b/docs/docs/components/01-clover-hub/server/appd/application-manifest.md new file mode 100644 index 0000000..655ceaf --- /dev/null +++ b/docs/docs/components/01-clover-hub/server/appd/application-manifest.md @@ -0,0 +1,27 @@ +# Application Manifest + +The application manifest is used by [arbiter](/docs/components/clover-hub/server/arbiter/intro) to provide permission consent, and for the application daemon to know how to interface with the application in a higher level manner. + +## Basics + +The simplest application manifest for an app that only takes [basic input] and does not require any other access to resources like the network, sensors, external displays, internal displays other than the primary one (defined by the primary intent provider, this may not actually be a display when using something like a passthrough internal display, but this application is unaware of that context). + +```json +{ + "version": "1.0.0", + "applications": { + "com.reboot-codes.clover.tutorial": { + "source": { + "source-type": "docker", + "dockerfile": "./Dockerfile" + }, + "name": "Tutorial Application", + "intents": { + "com.reboot-codes.clover.from-launcher": "ws-intent://./from-launcher" + } + } + } +} +``` + +Permissions for writing to the primary app display segment, basic input, etc are provided automatically by the `com.reboot-codes.clover.from-launcher` intent. Specifically a `ws-intent`. Not the most optimized way to interface with an app for it's main intent connection, but certainly the simplest. diff --git a/docs/docs/components/01-clover-hub/server/appd/intents.md b/docs/docs/components/01-clover-hub/server/appd/intents.md new file mode 100644 index 0000000..4e879ab --- /dev/null +++ b/docs/docs/components/01-clover-hub/server/appd/intents.md @@ -0,0 +1,22 @@ +# Intents + +Intents provide application entrypoints, and can be called by a few different sources, including other applications if they permit that. + +## Built-In Intents + +The application daemon officially recognizes the following intents + +### From Launcher + +`com.reboot-codes.clover.from-launcher` + +Provides registration with the chosen launcher, and default permissions to run within the launcher's main application context by default. + +## Intent Interfaces + +Intent interfaces define + +### WebSocket + +`` + diff --git a/docs/docs/components/clover-hub/server/appd/intro.md b/docs/docs/components/01-clover-hub/server/appd/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/appd/intro.md rename to docs/docs/components/01-clover-hub/server/appd/intro.md diff --git a/docs/docs/components/CORE/applications/main/_category_.yaml b/docs/docs/components/01-clover-hub/server/arbiter/_category_.yaml similarity index 100% rename from docs/docs/components/CORE/applications/main/_category_.yaml rename to docs/docs/components/01-clover-hub/server/arbiter/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/arbiter/intro.md b/docs/docs/components/01-clover-hub/server/arbiter/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/arbiter/intro.md rename to docs/docs/components/01-clover-hub/server/arbiter/intro.md diff --git a/docs/docs/components/clover-hub/server/arbiter/master-users.md b/docs/docs/components/01-clover-hub/server/arbiter/master-users.md similarity index 100% rename from docs/docs/components/clover-hub/server/arbiter/master-users.md rename to docs/docs/components/01-clover-hub/server/arbiter/master-users.md diff --git a/docs/docs/components/clover-hub/server/arbiter/permission-model.md b/docs/docs/components/01-clover-hub/server/arbiter/permission-model.md similarity index 100% rename from docs/docs/components/clover-hub/server/arbiter/permission-model.md rename to docs/docs/components/01-clover-hub/server/arbiter/permission-model.md diff --git a/docs/docs/components/CORE/expression-packs/_category_.yaml b/docs/docs/components/01-clover-hub/server/arbiter/stream-management/_category_.yaml similarity index 100% rename from docs/docs/components/CORE/expression-packs/_category_.yaml rename to docs/docs/components/01-clover-hub/server/arbiter/stream-management/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/arbiter/stream-management/audio-streams.md b/docs/docs/components/01-clover-hub/server/arbiter/stream-management/audio-streams.md similarity index 100% rename from docs/docs/components/clover-hub/server/arbiter/stream-management/audio-streams.md rename to docs/docs/components/01-clover-hub/server/arbiter/stream-management/audio-streams.md diff --git a/docs/docs/components/clover-hub/server/arbiter/stream-management/intro.md b/docs/docs/components/01-clover-hub/server/arbiter/stream-management/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/arbiter/stream-management/intro.md rename to docs/docs/components/01-clover-hub/server/arbiter/stream-management/intro.md diff --git a/docs/docs/components/clover-hub/server/arbiter/stream-management/video-streams.md b/docs/docs/components/01-clover-hub/server/arbiter/stream-management/video-streams.md similarity index 100% rename from docs/docs/components/clover-hub/server/arbiter/stream-management/video-streams.md rename to docs/docs/components/01-clover-hub/server/arbiter/stream-management/video-streams.md diff --git a/docs/docs/components/CORE/modules/_category_.yaml b/docs/docs/components/01-clover-hub/server/evtbuzz/_category_.yaml similarity index 100% rename from docs/docs/components/CORE/modules/_category_.yaml rename to docs/docs/components/01-clover-hub/server/evtbuzz/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/evtbuzz/auth.md b/docs/docs/components/01-clover-hub/server/evtbuzz/auth.md similarity index 100% rename from docs/docs/components/clover-hub/server/evtbuzz/auth.md rename to docs/docs/components/01-clover-hub/server/evtbuzz/auth.md diff --git a/docs/docs/components/clover-hub/server/evtbuzz/events.md b/docs/docs/components/01-clover-hub/server/evtbuzz/events.md similarity index 100% rename from docs/docs/components/clover-hub/server/evtbuzz/events.md rename to docs/docs/components/01-clover-hub/server/evtbuzz/events.md diff --git a/docs/docs/components/clover-hub/server/evtbuzz/intro.md b/docs/docs/components/01-clover-hub/server/evtbuzz/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/evtbuzz/intro.md rename to docs/docs/components/01-clover-hub/server/evtbuzz/intro.md diff --git a/docs/docs/components/clover-hub/server/evtbuzz/store.md b/docs/docs/components/01-clover-hub/server/evtbuzz/store.md similarity index 100% rename from docs/docs/components/clover-hub/server/evtbuzz/store.md rename to docs/docs/components/01-clover-hub/server/evtbuzz/store.md diff --git a/docs/docs/components/clover-hub/_category_.yaml b/docs/docs/components/01-clover-hub/server/inference-engine/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/_category_.yaml rename to docs/docs/components/01-clover-hub/server/inference-engine/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/inference-engine/intro.md b/docs/docs/components/01-clover-hub/server/inference-engine/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/inference-engine/intro.md rename to docs/docs/components/01-clover-hub/server/inference-engine/intro.md diff --git a/docs/docs/components/clover-hub/server/intro.md b/docs/docs/components/01-clover-hub/server/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/intro.md rename to docs/docs/components/01-clover-hub/server/intro.md diff --git a/docs/docs/components/clover-hub/server/_category_.yaml b/docs/docs/components/01-clover-hub/server/modman/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/_category_.yaml rename to docs/docs/components/01-clover-hub/server/modman/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/modman/intro.md b/docs/docs/components/01-clover-hub/server/modman/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/intro.md rename to docs/docs/components/01-clover-hub/server/modman/intro.md diff --git a/docs/docs/components/clover-hub/server/appd/_category_.yaml b/docs/docs/components/01-clover-hub/server/modman/modules/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/appd/_category_.yaml rename to docs/docs/components/01-clover-hub/server/modman/modules/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/modman/modules/app-modules.md b/docs/docs/components/01-clover-hub/server/modman/modules/app-modules.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/app-modules.md rename to docs/docs/components/01-clover-hub/server/modman/modules/app-modules.md diff --git a/docs/docs/components/clover-hub/server/arbiter/_category_.yaml b/docs/docs/components/01-clover-hub/server/modman/modules/components/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/arbiter/_category_.yaml rename to docs/docs/components/01-clover-hub/server/modman/modules/components/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/modman/modules/components/audio.md b/docs/docs/components/01-clover-hub/server/modman/modules/components/audio.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/components/audio.md rename to docs/docs/components/01-clover-hub/server/modman/modules/components/audio.md diff --git a/docs/docs/components/clover-hub/server/modman/modules/components/display.md b/docs/docs/components/01-clover-hub/server/modman/modules/components/display.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/components/display.md rename to docs/docs/components/01-clover-hub/server/modman/modules/components/display.md diff --git a/docs/docs/components/clover-hub/server/modman/modules/components/intro.md b/docs/docs/components/01-clover-hub/server/modman/modules/components/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/components/intro.md rename to docs/docs/components/01-clover-hub/server/modman/modules/components/intro.md diff --git a/docs/docs/components/clover-hub/server/modman/modules/components/movement.md b/docs/docs/components/01-clover-hub/server/modman/modules/components/movement.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/components/movement.md rename to docs/docs/components/01-clover-hub/server/modman/modules/components/movement.md diff --git a/docs/docs/components/clover-hub/server/modman/modules/components/sensor.md b/docs/docs/components/01-clover-hub/server/modman/modules/components/sensor.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/components/sensor.md rename to docs/docs/components/01-clover-hub/server/modman/modules/components/sensor.md diff --git a/docs/docs/components/clover-hub/server/modman/modules/components/video.md b/docs/docs/components/01-clover-hub/server/modman/modules/components/video.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/components/video.md rename to docs/docs/components/01-clover-hub/server/modman/modules/components/video.md diff --git a/docs/docs/components/clover-hub/server/modman/modules/intro.md b/docs/docs/components/01-clover-hub/server/modman/modules/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/intro.md rename to docs/docs/components/01-clover-hub/server/modman/modules/intro.md diff --git a/docs/docs/components/clover-hub/server/modman/modules/module-directory.md b/docs/docs/components/01-clover-hub/server/modman/modules/module-directory.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/module-directory.md rename to docs/docs/components/01-clover-hub/server/modman/modules/module-directory.md diff --git a/docs/docs/components/clover-hub/server/modman/modules/physical-modules.md b/docs/docs/components/01-clover-hub/server/modman/modules/physical-modules.md similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/physical-modules.md rename to docs/docs/components/01-clover-hub/server/modman/modules/physical-modules.md diff --git a/docs/docs/components/clover-hub/server/arbiter/stream-management/_category_.yaml b/docs/docs/components/01-clover-hub/server/renderer/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/arbiter/stream-management/_category_.yaml rename to docs/docs/components/01-clover-hub/server/renderer/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/renderer/intro.md b/docs/docs/components/01-clover-hub/server/renderer/intro.md similarity index 100% rename from docs/docs/components/clover-hub/server/renderer/intro.md rename to docs/docs/components/01-clover-hub/server/renderer/intro.md diff --git a/docs/docs/components/clover-hub/server/evtbuzz/_category_.yaml b/docs/docs/components/01-clover-hub/tui/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/evtbuzz/_category_.yaml rename to docs/docs/components/01-clover-hub/tui/_category_.yaml diff --git a/docs/docs/components/clover-hub/tui/intro.md b/docs/docs/components/01-clover-hub/tui/intro.md similarity index 100% rename from docs/docs/components/clover-hub/tui/intro.md rename to docs/docs/components/01-clover-hub/tui/intro.md diff --git a/docs/docs/components/clover-hub/server/inference-engine/_category_.yaml b/docs/docs/components/02-CORE/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/inference-engine/_category_.yaml rename to docs/docs/components/02-CORE/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/modman/_category_.yaml b/docs/docs/components/02-CORE/applications/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/modman/_category_.yaml rename to docs/docs/components/02-CORE/applications/_category_.yaml diff --git a/docs/docs/components/clover-hub/server/modman/modules/_category_.yaml b/docs/docs/components/02-CORE/applications/applib/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/_category_.yaml rename to docs/docs/components/02-CORE/applications/applib/_category_.yaml diff --git a/docs/docs/components/CORE/applications/applib/intro.md b/docs/docs/components/02-CORE/applications/applib/intro.md similarity index 100% rename from docs/docs/components/CORE/applications/applib/intro.md rename to docs/docs/components/02-CORE/applications/applib/intro.md diff --git a/docs/docs/components/CORE/applications/intro.md b/docs/docs/components/02-CORE/applications/intro.md similarity index 100% rename from docs/docs/components/CORE/applications/intro.md rename to docs/docs/components/02-CORE/applications/intro.md diff --git a/docs/docs/components/clover-hub/server/modman/modules/components/_category_.yaml b/docs/docs/components/02-CORE/applications/main/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/modman/modules/components/_category_.yaml rename to docs/docs/components/02-CORE/applications/main/_category_.yaml diff --git a/docs/docs/components/CORE/applications/main/expression-replication.md b/docs/docs/components/02-CORE/applications/main/expression-replication.md similarity index 100% rename from docs/docs/components/CORE/applications/main/expression-replication.md rename to docs/docs/components/02-CORE/applications/main/expression-replication.md diff --git a/docs/docs/components/CORE/applications/main/intro.md b/docs/docs/components/02-CORE/applications/main/intro.md similarity index 100% rename from docs/docs/components/CORE/applications/main/intro.md rename to docs/docs/components/02-CORE/applications/main/intro.md diff --git a/docs/docs/components/CORE/applications/settings.md b/docs/docs/components/02-CORE/applications/settings.md similarity index 100% rename from docs/docs/components/CORE/applications/settings.md rename to docs/docs/components/02-CORE/applications/settings.md diff --git a/docs/docs/components/clover-hub/server/renderer/_category_.yaml b/docs/docs/components/02-CORE/expression-packs/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/server/renderer/_category_.yaml rename to docs/docs/components/02-CORE/expression-packs/_category_.yaml diff --git a/docs/docs/components/CORE/expression-packs/intro.md b/docs/docs/components/02-CORE/expression-packs/intro.md similarity index 100% rename from docs/docs/components/CORE/expression-packs/intro.md rename to docs/docs/components/02-CORE/expression-packs/intro.md diff --git a/docs/docs/components/CORE/intro.md b/docs/docs/components/02-CORE/intro.md similarity index 100% rename from docs/docs/components/CORE/intro.md rename to docs/docs/components/02-CORE/intro.md diff --git a/docs/docs/components/clover-hub/tui/_category_.yaml b/docs/docs/components/02-CORE/modules/_category_.yaml similarity index 100% rename from docs/docs/components/clover-hub/tui/_category_.yaml rename to docs/docs/components/02-CORE/modules/_category_.yaml diff --git a/docs/docs/components/CORE/modules/intro.md b/docs/docs/components/02-CORE/modules/intro.md similarity index 100% rename from docs/docs/components/CORE/modules/intro.md rename to docs/docs/components/02-CORE/modules/intro.md diff --git a/docs/docs/components/spanner/_category_.yaml b/docs/docs/components/03-spanner/_category_.yaml similarity index 100% rename from docs/docs/components/spanner/_category_.yaml rename to docs/docs/components/03-spanner/_category_.yaml diff --git a/docs/docs/components/spanner/desktop/_category_.yaml b/docs/docs/components/03-spanner/desktop/_category_.yaml similarity index 100% rename from docs/docs/components/spanner/desktop/_category_.yaml rename to docs/docs/components/03-spanner/desktop/_category_.yaml diff --git a/docs/docs/components/spanner/desktop/intro.md b/docs/docs/components/03-spanner/desktop/intro.md similarity index 100% rename from docs/docs/components/spanner/desktop/intro.md rename to docs/docs/components/03-spanner/desktop/intro.md diff --git a/docs/docs/components/spanner/intro.md b/docs/docs/components/03-spanner/intro.md similarity index 100% rename from docs/docs/components/spanner/intro.md rename to docs/docs/components/03-spanner/intro.md diff --git a/docs/docs/components/spanner/lib/_category_.yaml b/docs/docs/components/03-spanner/lib/_category_.yaml similarity index 100% rename from docs/docs/components/spanner/lib/_category_.yaml rename to docs/docs/components/03-spanner/lib/_category_.yaml diff --git a/docs/docs/components/03-spanner/lib/intro.md b/docs/docs/components/03-spanner/lib/intro.md new file mode 100644 index 0000000..f266dad --- /dev/null +++ b/docs/docs/components/03-spanner/lib/intro.md @@ -0,0 +1,3 @@ +# SpannerLib + +SpannerLib is designed to provide a well documented and safe interface for connecting to Clover from an external device (not a [module](/docs/components/clover-hub/server/modman/modules/intro) or [application](/docs/components/clover-hub/server/appd/intro)). It's written in rust and will eventually provide bindings for several languages. \ No newline at end of file diff --git a/docs/docs/components/clover-hub/server/appd/application-manifest.md b/docs/docs/components/clover-hub/server/appd/application-manifest.md deleted file mode 100644 index dd52a90..0000000 --- a/docs/docs/components/clover-hub/server/appd/application-manifest.md +++ /dev/null @@ -1,3 +0,0 @@ -# Application Manifest - -The application manifest is used by [arbiter](/docs/components/clover-hub/server/arbiter/intro) to provide permission consent, and for the application daemon to know how to interface with the application in a higher level manner. diff --git a/docs/docs/components/spanner/lib/intro.md b/docs/docs/components/spanner/lib/intro.md deleted file mode 100644 index b917c57..0000000 --- a/docs/docs/components/spanner/lib/intro.md +++ /dev/null @@ -1,3 +0,0 @@ -# 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. \ No newline at end of file