Skip to content

Commit aa7ec5f

Browse files
authored
feat: Improve the quality of the documentation (#53)
* Update docker.md * Update docker.md * Update docker.md * Create retrieve-token * Rename retrieve-token to retrieve-token.md * Rename first_startup.png to first_startup.png * Rename retrieve-token.md to retrieve_token.md * feat: Improve docs
1 parent c6ddfca commit aa7ec5f

8 files changed

Lines changed: 46 additions & 12 deletions

File tree

docs/api/options/jvm.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,13 @@ To include the API in your Maven project, add the following dependency to your `
1111
<artifactId>api</artifactId>
1212
<version>0.1.0-SNAPSHOT</version>
1313
</dependency>
14+
```
15+
16+
## Gradle
17+
To include the API in your Gradle project, add the following dependency to your `build.gradle` file:
18+
19+
```kotlin
20+
dependencies {
21+
implementation("io.atomic.cloud:api:0.1.0-SNAPSHOT")
22+
}
1423
```

docs/cli/index.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
1-
# CLI 🚧
1+
# CLI
22

3-
This page is currently a work in progress.
3+
This page provides instructions on how to download and use the CLI for controlling the controller.
44

5-
We’re actively working to provide accurate and useful content here. Please check back soon for updates
5+
## Download the CLI
6+
7+
You can download the latest CLI binary from the [GitHub releases page](https://github.com/HttpRafa/atomic-cloud/releases/).
8+
9+
## Installation
10+
11+
1. Download the appropriate binary for your operating system.
12+
2. Place the binary in a directory that is included in your system's PATH.
13+
14+
## Usage
15+
16+
Run the CLI from your terminal and follow the instructions provided by the CLI to control the controller.
17+
18+
We’re actively working to provide more detailed and useful content here. Please check back soon for updates.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Installation
2+
3+
1. Download the `local-driver.wasm` file from the [GitHub releases page](https://github.com/HttpRafa/atomic-cloud/releases/).
4+
2. Place the downloaded file into the `drivers` directory.
5+
3. Start the controller.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Installation
2+
3+
1. Download the `pterodactyl-driver.wasm` file from the [GitHub releases page](https://github.com/HttpRafa/atomic-cloud/releases/).
4+
2. Place the downloaded file into the `drivers` directory.
5+
3. Start the controller.

docs/controller/installation/docker.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,3 @@ To start the container, execute the following command:
3030
```bash
3131
docker compose up
3232
```
33-
34-
## Step 3: Retrieve the Admin Token
35-
Upon the initial run of the controller, an admin token will be displayed. This token is required to connect using the CLI. For further details, refer to [How to use the CLI](/cli/).
36-
![First Startup](docker/first_startup.png)
37-
38-
## Step 4: Retrieve the Admin Token Later (If Needed)
39-
In case you lose the token, it can be retrieved from the default admin user's file located in the `auth/users` directory.
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Normal 🚧
22

3-
This page is currently a work in progress.
3+
This page is currently a work in progress.
44

5-
We’re actively working to provide accurate and useful content here. Please check back soon for updates
5+
For the latest releases and updates, please visit our [GitHub release page](https://github.com/HttpRafa/atomic-cloud/releases/).
6+
7+
We’re actively working to provide accurate and useful content here. Please check back soon for updates.
File renamed without changes.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Retrieve the Admin Token on First Launch
2+
When you run the controller for the first time, an admin token will be displayed. You will need this token to connect via the CLI. For more information, see [How to use the CLI](/cli/).
3+
4+
![First Startup](images/first_startup.png)
5+
6+
## Retrieve the Admin Token After the First Launch
7+
If you lose the token, you can retrieve it from the default admin user's file, located in the `auth/users` directory.

0 commit comments

Comments
 (0)