Add docs

Signed-off-by: Sayan Nandan <[email protected]>

Author: ohsayan

.gitignore

@@ -1,10 +1,13 @@
-# Generated by Cargo
-# will have compiled files and executables
-/target/
-
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
-
-# These are backup files generated by rustfmt
-**/*.rs.bk
+.DS_Store
+.vscode
+.idea
+*.iml
+*.code-workspace
+.changelog
+node_modules
+.yarn
+.eslintcache
+yarn-error.log
+build
+.docusaurus
+.cache-loader

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/1.index.md

@@ -0,0 +1,27 @@
+---
+id: index
+title: Introduction
+sidebar_label: Home
+slug: /
+---
+Welcome to Skybase's docs! You will find information about how you can get started with Skybase, installation options, configuration and clients.
+
+:::note Caution
+This documentation is for Skybase versions built off the `next` branch and is not very stable. To use a pre-built binary and see its corresponding instructions, click on the version dropdown towards the upper left to select a version.
+:::
+
+## Users
+
+Since you're building off `next`, you'll have to [build from source](building-from-source). Once you've got everything up and running, you can take a look at the available actions [here](actions/overview) and [configuration files](config-files).
+
+## Developers	
+
+You can find information on how to build your own clients [here](Protocol/terrapipe). The primary idea is to implement the Terrapipe Protocol.
+
+## Contributing
+
+If you find any typos, mistakes or any other scope of improvement - please don't hesitate to bring it up [here](https://github.com/skybasedb/docs/issues). Thank you ❤️!
+
+## License
+
+The documentation is licensed under the [CC-BY-SA-4.0 License](https://github.com/skybasedb/docs/tree/master/LICENSE)

docs/2.getting-started.md

@@ -0,0 +1,84 @@
+---
+id: getting-started
+title: Getting Started
+---
+:::warning
+This is for release v0.5.0
+:::
+Getting started with Skybase is easy 😊 (and fun!). You can get started with [native binaries (recommended)](#get-started-with-bundles) or by using the [docker image](#get-started-with-docker).
+
+## Get started with bundles
+
+### Step 1: Download a bundle
+
+Head over to the [releases page](https://github.com/terrabasedb/terrabase/releases) and download the latest version for your platform.
+
+### Step 2: Make the files runnable
+
+Unzip the `zip` file that you just downloaded. If you're on a *nix system, run `chmod +x tdb skysh` to make the files executable. If you're on Windows, right-click the files and then check the `UNBLOCK` checkbox and click on the `APPLY` button.
+
+### Step 3: Start the database server
+
+In the directory where you extracted the files, run `./tdb` on *nix systems or simply `tdb` on Windows systems. That's all there is to starting the database server!
+
+### Step 4: Run the shell `skysh`
+
+`skysh` is the shell that is shipped with the bundle. Run it, just like you did with the database server. Now enter commands in the shell, and have fun! First run `HEYA` to check if everything is fine - the server should reply with _HEY!_.
+See all the available actions [here](actions/overview)
+
+You're done with setting up `tdb` 🎉!
+
+## Get started with Docker
+
+First of all, you need to have Docker installed and available on your `PATH` ; you can read the official guide [here](https://docs.docker.com/get-docker/). Once you've got Docker up and running, follow the steps!
+
+### Step 0: Create a container
+
+Open up a terminal and run:
+
+``` 
+docker create terrabasedb/tdb --name tdbvm
+```
+
+:::note
+You may need superuser privileges
+:::
+At the same time, you'll need to set up the bundle by following [Step 1](#step-1-download-a-bundle) and [Step 2](#step-2-make-the-files-runnable) from the previous section.
+
+### Step 1: Start the container
+
+Now run:
+
+``` 
+docker start tdbvm
+```
+
+:::note
+You may need superuser privileges
+:::
+### Step 2: Find the IP address of the container
+
+In order to connect to the container (which, to `skysh` is nothing but a remote server), you'll have to run:
+
+``` shell
+docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' tdbvm
+```
+
+:::note
+You may need superuser privileges
+:::
+And you'll get a result like:
+
+``` text
+172.17.0.1
+```
+
+### Step 3: Start the command line client
+
+Open up a terminal in the directory where you downloaded the command line client and run:
+
+``` shell
+skysh -h 172.17.0.1
+```
+
+And you're done!

docs/3.building-from-source.md

@@ -0,0 +1,42 @@
+---
+id: building-from-source
+title: Building from source
+---
+Of course you can build it from source — but with quite a bit of hassle. The database server is a bit fussy with its builds, so you'll need quite a few tools before you can actually start using it.
+
+### Step 1: Install pre-requisites
+As Skybase is written in Rust, you'll have to install the Rust toolchain to build it (a little messy, but not too messy). Go to [this page](https://rustup.rs/) to set up Rust on your local machine.
+
+Besides, the TLS/SSL components are written in C (OpenSSL) — so you'll need to install:
+* A C compiler for your platform
+* GNU Make (`make`)
+* Perl
+
+### Step 2: Clone the tag
+Run this from your terminal:
+```
+git clone --branch next https://github.com/skybasedb/skybase.git
+```
+:::tip Bonus tip
+If you want to avoid downloading all the version history, run this instead:
+```
+git clone --depth 1 --branch next https://github.com/skybasedb/skybase.git
+```
+:::
+### Step 3: Build it!
+Expecting that you're still in the same directory, run:
+```
+cd skybase && cargo build --release
+```
+:::note
+This will take **crazy long** at times, so hold on until Cargo finishes building things
+:::
+:::note Important note
+Since you're building off `next`, it's always a good idea to create a debug build than a release build as you'll find some bugs which we'd love you to report [here](https://github.com/skybasedb/skybase). 
+
+To create a debug build, just run `cargo build`, omitting the `release` flag.
+:::
+### Step 4: Get the binaries
+You'll need to copy `sdb` and `skysh` (or `sdb.exe` and `skysh.exe` if on Windows) from the `skybase/target/release` folder. Be sure to copy these **exact files** and not something else!
+### Step 5: Run it!
+Now start the database server by running `./tdb` and then start the interactive shell by running `./tsh`. You're ready to use the [actions](actions/overview)!

docs/4.persistence.md

@@ -0,0 +1,14 @@
+---
+id: persistence
+title: Persistence
+---
+Skybase supports the persistent storage of data, which is an inherently obvious need for any database. In this document we explore how Skybase's persistence works. 
+
+## How TDB stores data
+
+Whenever you start the database, TDB looks for a `data.bin` file, which contains data from the previous run of the database server. This is a binary file and should not be edited by hand: as you might end up corrupting the file.
+When you shut down the database, TDB stops stops listening to all incoming connections, and then flushes the entire in-memory table onto disk and then shutting down.
+
+## Automated background saving
+
+Since 0.4.2, Skybase supports automated saving of data in the background, via `BGSAVE` . `BGSAVE` , runs every two minutes to flush all the data in the in-memory table onto disk, unless customized through the [configuration file](config-files/#an-example-configuration).

docs/5.benchmarking.md

@@ -0,0 +1,23 @@
+---
+id: benchmarking
+title: Benchmarking
+---
+Who doesn't like speed and as a consequence, benchmarks? So here's a guide on benchmarking Skybase with our tool `sky-bench` .
+
+## Step 0: Getting the benchmarking tool
+
+The benchmark tool ( `sky-bench` ) has been shipped as a part of the Skybase bundle ever since 0.3.2. So, you'll need to download a bundle from the [releases page](https://github.com/skybasedb/skybase/releases) and unzip it. In the following steps we'll assume that you have unzipped the archive and you're in that directory. 
+:::tip
+If you're building off `next`, then you will need to copy the `sky-bench` binary from the `target/release` or `target/debug` directory.
+:::
+## Step 1: Starting the database server
+
+Open a terminal in the current directory and [set executable permissions](getting-started/#step-2-make-the-files-runnable). Now start the server by running `./sdb` (or just `sdb` on Windows).
+
+## Step 2: Run the benchmark tool
+
+Open another terminal in the current directory and then run `sky-bench` with no arguments if you want to use the default options, or run `sky-bench --help` to see available configuration options. Hold tight, you'll know when it happens 🚀.
+
+### Bonus: JSON Output
+
+If you're a bit nerdy, we know it — you'll like some structured data. Well, all you need to do is: run `sky-bench --json` for JSON output!

docs/5.cfg-files.md

@@ -0,0 +1,53 @@
+---
+id: config-files
+title: Configuration Files
+---
+Skybase supports custom configuration files to let users customize the functioning of TDB. Arguably, TDB has one of the simplest configuration files around. Skybase also allows configuration via [command line arguments](config-cmd).
+
+## An example configuration
+
+A configuration file is a TOML file, which looks like:
+
+``` toml
+[server]
+host = "127.0.0.1"
+port = 2003
+noart = false
+
+[bgsave]
+enabled = true
+every = 120 # Every 120 seconds
+```
+
+This is the default configuration used by TDB when you don't specify a configuration file. Let's understand what each of the keys mean:
+
+* `server` :
+    - `host` : This is the IP address to which you want the database server to bind to. It can be any valid IPv4 *or* IPv6 address, as a quoted string
+    - `port` : This is the port to which you want TDB to bind to
+    - `noart` (OPTIONAL): This is **an optional argument** and is recommended for secure environments where displaying terminal artwork might cause problems
+* `bgsave`:
+    - `enabled` : This is an optional key, which is to be set to true to enable BGSAVE or false to disable it. If this key is not specified, TDB will enable BGSAVE by default
+    - `every` : Run BGSAVE `every` seconds. So, for example, if you set this to 120, BGSAVE will run every two minutes. This is also an optional key, and if you don't provide it, the default BGSAVE duration of 120 seconds is used
+* `snapshot` (OPTIONAL): This key can be used to configure snapshots and is not enabled by default. See [this](snapshots) for more information.
+
+## Using a configuration file
+
+To use a configuration file:
+
+1. Create it! We recommend you to name it as `sdb.toml` for easy identification
+2. Start the database server with: `sdb -c /path/to/your/file.toml`
+3. Done 🎉
+
+If you're confused about creating a configuration file, we always recommend you to download a sample file from [this link](https://github.com/skybasedb/skybase/blob/next/examples/config-files/template.toml). Do note that this file is bleeding-edge and as a result will have new keys as they're created upstream.
+
+That's all that's there for using configuration files!
+:::tip Bonus tip
+If you're using a custom host/port, then you can bind `skysh` to a custom host/port by starting `skysh` like:
+```shell
+skysh -h [HOST] -p [PORT]
+```
+You can do the same for `sky-bench`:
+```shell
+sky-bench -h [HOST] -p [PORT]
+```
+:::

docs/Actions/1.actions.md

@@ -0,0 +1,23 @@
+---
+id: overview
+title: Actions overview
+---
+Actions are like shell commands: they take arguments and do something! Skybase currently supports the following actions: 
+
+* [DBSIZE](dbsize)
+* [DEL](del)
+* [EXISTS](exists)
+* [FLUSHDB](flushdb)
+* [GET](get)
+* [HEYA](heya)
+* [KEYLEN](keylen)
+* [MGET](mget)
+* [MKSNAP](mksnap)
+* [MSET](mset)
+* [MUPDATE](mupdate)
+* [SDEL](sdel)
+* [SET](set)
+* [SSET](sset)
+* [SUPDATE](supdate)
+* [UPDATE](update)
+* [USET](uset)

docs/Actions/DBSIZE.md

@@ -0,0 +1,11 @@
+---
+id: dbsize
+title: DBSIZE
+---
+:::note About
+**Since**: 0.4.3  
+**Time complexity**: O(1)  
+**Arguments**: `DBSIZE`  
+**Returns**: Number of keys that exist in the database as an unsigned int  
+:::
+Number of key/value pairs stored in the database