Skip to content

Commit 3b3aec6

Browse files
ohsayanohsayan
committed
Reorganize some docs
1 parent 2b3e045 commit 3b3aec6

File tree

3 files changed

+25
-24
lines changed

3 files changed

+25
-24
lines changed

‎docs/13.libraries.md‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ title: Client drivers
66

77
## Official drivers
88

9-
We officially maintain the following drivers:
9+
The drivers that are officially maintained can be expected to be feature complete and stable. We currently support the following drivers:
1010

11-
- [Rust driver](https://github.com/skytable/client-rust) [Apache-2.0] - Always up to date and is used by the core project itself
12-
- [NodeJS driver **(WIP)**](https://github.com/skytable/client-nodejs) [Apache-2.0]: Currently a work in progress to try and build an idiomatic NodeJS driver
11+
| Language/Framework | Source Code | Status |
12+
| ------------------------------ | --------------------------------------------------- | -------- |
13+
| Rust | [GitHub](https://github.com/skytable/client-rust) | Stable ✅ |
14+
| NodeJS (JavaScript/TypeScript) | [GitHub](https://github.com/skytable/client-nodejs) | Beta 🏗 |
1315

1416
:::info More lanugages
1517
The team is always looking to support more languages and we wish we could ship more drivers. But due to limited
@@ -22,12 +24,12 @@ List of community powered drivers (sorted alphabetically):
2224

2325
| Language/Framework | Client source code | Upstreamed | License | Remarks |
2426
| -------------------------------- | ------------------------------------------------------------- | ---------- | ---------- | --------------------------------------------------------------------------------- |
25-
| **C#/.NET** | | ❗ | | |
26-
| | [C# driver](https://github.com/martinmolin/skytable-dotnet) | ❗ | Apache-2.0 | Available on [NuGet](https://www.nuget.org/packages/Skytable.Client) |
27-
| **Go** | | ❗ | | |
28-
| | [Go driver](https://github.com/No3371/go-skytable) | ❗ | Apache-2.0 | Written from scratch |
29-
| | [Go driver](https://github.com/satvik007/skytable-go) | ❗ | Apache-2.0 | Easy for migration from go-redis |
30-
| **JavaScript/TypeScript (Node)** | | ❗ | | |
31-
| | [NodeJS Driver](https://github.com/zhangyuannie/skytable.js) | ❗ | Apache-2.0 | Available on [npm](https://www.npmjs.com/package/skytable.js) |
32-
| **PHP** | | ❗ | | |
33-
| | [PHP client driver](https://github.com/hkulekci/skytable-php) | ❗ | MIT | Can be found on [Packagist](https://packagist.org/packages/hkulekci/skytable-php) |
27+
| **C#/.NET** | | ❗ | | |
28+
| | [C# driver](https://github.com/martinmolin/skytable-dotnet) | ❗ | Apache-2.0 | Available on [NuGet](https://www.nuget.org/packages/Skytable.Client) |
29+
| **Go** | | ❗ | | |
30+
| | [Go driver](https://github.com/No3371/go-skytable) | ❗ | Apache-2.0 | Written from scratch |
31+
| | [Go driver](https://github.com/satvik007/skytable-go) | ❗ | Apache-2.0 | Easy for migration from go-redis |
32+
| **JavaScript/TypeScript (Node)** | | ❗ | | |
33+
| | [NodeJS Driver](https://github.com/zhangyuannie/skytable.js) | ❗ | Apache-2.0 | Available on [npm](https://www.npmjs.com/package/skytable.js) |
34+
| **PHP** | | ❗ | | |
35+
| | [PHP client driver](https://github.com/hkulekci/skytable-php) | ❗ | MIT | Can be found on [Packagist](https://packagist.org/packages/hkulekci/skytable-php) |

‎docs/2.installation.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@ Getting started with Skytable involves choosing a mode of installation, download
1212
1313
## Native binaries
1414

15-
:::info
16-
Your operating system might sometimes not let you run binaries directly. On Unix based systems, you'll need to run: `chmod +x skyd skysh sky-bench`.
17-
18-
And on Windows systems you might need to right-click on the binaries and click on "unblock"
19-
:::
20-
2115
To use native binaries you need to download a bundle which is simply a ZIP file with all the necessary binaries that you'll ever need to develop on and deploy Skytable.
2216

2317
1. **First download the latest bundle** for your platform. You can find [download links on the releases page](https://github.com/skytable/skytable/releases).
@@ -39,6 +33,12 @@ To use native binaries you need to download a bundle which is simply a ZIP file
3933

4034
The server starts up at `localhost:2003` and is ready to run queries.
4135

36+
:::info
37+
Your operating system might sometimes not let you run binaries directly. On Unix based systems, you'll need to run: `chmod +x skyd skysh sky-bench`.
38+
39+
And on Windows systems you might need to right-click on the binaries and click on "unblock"
40+
:::
41+
4242
## Debian package
4343
4444
Find the correct `*.deb` file [from the releases page](https://github.com/skytable/skytable/releases). Now simply run:
@@ -71,7 +71,7 @@ The package will:
7171
```
7272
7373
:::tip
74-
The password for the Skytable instance on the Docker container is auto-generated Run `docker logs -f skydb` and you'll see a log
74+
The password for the Skytable instance on the Docker container is auto-generated. Run `docker logs -f skydb` and you'll see a log
7575
message with the generated password.
7676
:::
7777

‎docs/resources/1.overview.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ title: Resources
55

66
## Community and chat
77

8-
The community platform that we use the most is Discord. Here is a link to [our Discord Community](https://discord.gg/QptWFdx).
9-
Both our developers and users hang out almost all day around here, so you can expect to get your query resolved fairly quickly.
8+
- [**Discord Community**](https://discord.gg/QptWFdx): The community platform that we use the most is Discord. Both our developers and users hang out almost all day around here, so you can expect to get your query resolved fairly quickly.
9+
- [**GitHub Discussions**](https://github.com/skytable/skytable/discussions): If you prefer a more forum like discussion, then please make use of GitHub Discussions. We're fairly responsive here as well.
1010

1111
## News
1212

13-
- [**Skytable Blog**](https://blog.skytable.io): This is where you'll hear from us about major updates such as new releases, changes in maintenance and such
13+
- [**Skytable Blog**](https://skytable.io/blog): This is where you'll hear from us about major updates such as new releases, changes in maintenance and such
1414
- [**X/Twitter**](https://twitter.com/skytabledb): On X (formerly Twitter), we post live updates as we work on new features. If there's a quick update or milestone, you'll be the first to know here
1515
- [**E-mail**](https://cdn.forms-content.sg-form.com/e4a9719e-d94e-11eb-89d2-9232e6ded8b5): While we haven't ever sent out any e-mails, if you're keen on signing up for updates in the (near) future, it's a good idea to subscribe to this list. Just like we said, we haven't yet sent out anything! We're building software, not sending you fancy email!
1616

@@ -19,7 +19,6 @@ Both our developers and users hang out almost all day around here, so you can ex
1919
- [**Jotsy (rust)**](https://github.com/ohsayan/jotsy): Jotsy is a very small "blog" implementation that is written in Rust with Skytable and the Axum framework. If you're building something in Rust, do check it out
2020
- [**Client repo (rust)**](https://github.com/skytable/client-rust): While this is in Rust, you might find the examples useful regardless of which language you're developing your application in
2121

22-
2322
## Client drivers
2423

25-
Please head over to the [libraries](libraries) page.
24+
Please head over to the [libraries](/libraries) page.

0 commit comments

Comments
 (0)