Skip to content

Commit d83ef9a

Browse files
author
Alexander Söderberg
committed
chore: port over the existing docs
1 parent e804a14 commit d83ef9a

File tree

3 files changed

+46
-3
lines changed

3 files changed

+46
-3
lines changed

docs/index.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
11
# Cloud
22

3-
Hello :)
3+
Cloud is a JVM framework for creating user commands.
4+
A command is a chain of parsed arguments and a handler that gets invoked with the parsed values.
5+
Cloud is not made to be used in any specific software, but it has modules with support for Minecraft
6+
(Bukkit/Paper, BungeeCord, Velocity, Fabric, CloudBurst, Sponge & NeoForge), Discord (JavaCord & JDA)
7+
and IRC (PIrcBotX).
8+
9+
Cloud allows you to write commands either using builders or annotated methods, and has special support for Kotlin.
10+
Cloud allows you to customize the command execution pipeline by injecting custom behavior along the entire
11+
execution path.
12+
13+
This document does not aim to cover every single detail of Cloud, but will instead introduce you to various different
14+
concepts and explain how they can be used in your software
15+
For technical details, we ask you to look at the [JavaDoc](https://javadocs.dev/cloud.commandframework).
16+
17+
We have a set of examples that introduce some useful Cloud concepts.
18+
They are written for the Bukkit Minecraft API but the examples are not specific to Minecraft:
19+
[example-bukkit](https://github.com/Incendo/cloud/tree/iCLOUD_BASE_BRANCHi/examples/example-bukkit).
20+
21+
## Structure
22+
23+
The documentation is split into different sections for the different Cloud modules.
24+
It is highly recommended that you get started with the [cloud-core](./core/index.md) docs before you delve into the
25+
platform-specific docs.
26+
If you want to use annotated command methods, then you should start out with [cloud-core](./core/index.md) and then
27+
move over to [cloud-annotations](./annotations/index.md).
28+
29+
## Development Builds
30+
31+
Development builds of Cloud are available on the Sonatype Snapshots Repository:
32+
33+
```xml
34+
<repository>
35+
<id>sonatype-snapshots</id>
36+
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
37+
</repository>
38+
```

mkdocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,17 @@ site_url: https://cloud.incendo.org/
44
repo_url: https://github.com/incendo/cloud-docs
55
repo_name: cloud-docs
66
nav:
7-
- Home: index.md
7+
- Cloud:
8+
- Home: index.md
89
- cloud-core:
910
- Information: core/index.md
1011
- cloud-annotations:
1112
- Information: annotations/index.md
1213
- cloud-kotlin:
1314
- Information: kotlin/index.md
15+
- Annotations: kotlin/annotations.md
16+
- Coroutines: kotlin/coroutines.md
17+
- Extensions: kotlin/extensions.md
1418
- cloud-discord:
1519
- Information: discord/index.md
1620
- cloud-javacord: discord/javacord.md

placeholder-plugin.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
placeholders:
2-
CLOUD_BASE_VERSION: 2.0.0-dev
2+
CLOUD_BASE_VERSION:
3+
default: 2.0.0-dev
4+
CLOUD_BASE_BRANCH:
5+
default: 2.0.0-dev
6+
replace_everywhere: true
37
settings:
48
auto_placeholder_tables: false

0 commit comments

Comments
 (0)