Just some more docs (#462)

* docs init

* small tweaks
This commit is contained in:
Jamie Pine
2023-01-23 14:31:20 -08:00
committed by GitHub
parent 81dcd9795c
commit f4e8043cd6
11 changed files with 70 additions and 8 deletions

View File

@@ -1,3 +1,4 @@
# Privacy Policy
_This page has yet to be written out in full. Please check back later!_

View File

@@ -1,7 +1,19 @@
---
index: 4
index: 10
---
# Database
prisma client rust, sqlite, migrations, backup
### Schema
Our data schema is defined using Prisma, you can [view it on GitHub](https://github.com/spacedriveapp/spacedrive/blob/main/core/prisma/schema.prisma).
![A cool screenshot of the Spacedrive schema](/schema.webp)
### Prisma Client Rust
We use Prisma Client Rust as a database ORM, it allows us to use Prisma to define our schema and generate migrations based on modifications to that schema.
### Migrations
Migrations are run by the Prisma migration engine on app launch.
### Database file
The databases file is SQLite and can be opened in any SQL viewer.
![A Spacedrive library database file open in Table Plus](/database-table-plus.webp)

View File

@@ -1,7 +1,17 @@
---
index: 10
index: 4
---
# Explorer
using the interface, features
### Grid view
### List View
### Columns View
### Media View
### Timeline View
### Configuration

View File

@@ -4,4 +4,4 @@ index: 10
# Extensions
extended functionality of Spacedrive
Extensions are planned but nothing is yet set in stone.

View File

@@ -4,4 +4,9 @@ index: 1
# Libraries
A library is the database that Spacedrive stores all file structures and metadata. It can be synchronized with other [Nodes]()
A library is the database that Spacedrive stores all file structures and metadata. It can be synchronized with other [Nodes]().
To learn how data is synchronized check out the documentation on [Sync](/docs/developers/architecture/sync).
Libraries can be encrypted with a passphrase set by the user.

View File

@@ -1,5 +1,5 @@
---
index: 3
index: 5
---
# Spaces

View File

@@ -1,3 +1,7 @@
---
index: 10
---
# CLI
A CLI is planned, it would allow a user or application to connect and control a running Spacedrive node on a local or remote system.

View File

@@ -0,0 +1,7 @@
---
index: 10
---
# Rust
This doc should just show how to import the core and use it in a Rust context.

View File

@@ -7,3 +7,5 @@ index: 0
```rust
pub struct DeveloperDocumentation;
```
This documentation is a work in progress, you will find unfinished or empty sections.

View File

@@ -3,7 +3,9 @@ name: Introduction
index: 0
---
# Welcome to Spacedrive
# Meet Spacedrive
![image](/app-ui-explorer.webp)
Spacedrive is a cross-platform file manager. It connects your devices together to help you organize files from anywhere.

View File

@@ -4,3 +4,22 @@ index: 0
---
# Terminology
Some useful Spacedrive related terminology.
### `Library`
A Library is the database that powers Spacedrive, all metadata and directory structures are saved in the Library. Libraries can be synced between devices and a user can have multiple libraries loaded in the Spacedrive app at once. [Learn more →](/docs/developers/architecture/libraries)
### `Object`
Objects are a fancy name for files, we call them Objects because we identify them uniquely based on a cryptographic hash of the contents. Objects in Spacedrive can come in a wide variety of kinds to provide a broad range of context. [Learn more →](/docs/developers/architecture/objects)
### `Location`
Locations are places Spacedrive will look for files, usually a directory on a mounted volume, but could also be a cloud service. [Learn more →](/docs/developers/architecture/locations)
### `Node`
A Node is a device or server running the Spacedrive core. Nodes can host libraries and communicate with other Nodes to sync data. [Learn more →](/docs/developers/architecture/nodes)
### `Preview Media`
Preview media refers to highly compressed image or video content for an Object, it is generated by Spacedrive and synced between your devices. [Learn more →](/docs/developers/architecture/preview-media)