Skip to content

Commit

Permalink
Add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Reboot-Codes committed Oct 3, 2024
1 parent d6ff1c8 commit 221f2af
Show file tree
Hide file tree
Showing 65 changed files with 52 additions and 6 deletions.
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,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.
22 changes: 22 additions & 0 deletions docs/docs/components/01-clover-hub/server/appd/intents.md
Original file line number Diff line number Diff line change
@@ -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

``

File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/docs/components/03-spanner/lib/intro.md
Original file line number Diff line number Diff line change
@@ -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.

This file was deleted.

3 changes: 0 additions & 3 deletions docs/docs/components/spanner/lib/intro.md

This file was deleted.

0 comments on commit 221f2af

Please sign in to comment.