Reorganize existing guides (backport #492) (#528)

* Reorganize existing guides (#492) * Moves all guides to a guids folder * Moves the actual intro to the README.md of the intro folder * Add guides to the guide README.md * Fixing links in docs/README.md (cherry picked from commit fa98b5e) # Conflicts: # docs/README.md # docs/guides/java.md # docs/guides/kotlin.md # docs/introduction/README.md # docs/introduction/what-is-cometbft.md * solving conflicts * Add guides to the guide README.md --------- Co-authored-by: Lasaro <[email protected]>
celestiaorg · Mar 14, 2023 · c7edf61 · c7edf61
1 parent ad2b3bd
commit c7edf61
Show file tree

Hide file tree

Showing 11 changed files with 342 additions and 33 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -16,13 +16,12 @@ CometBFT serves blockchain applications.
 
 More formally, CometBFT performs Byzantine Fault Tolerant (BFT)
 State Machine Replication (SMR) for arbitrary deterministic, finite state machines.
-For more background, see [What is CometBFT?](introduction/what-is-cometbft.md).
+For more background, see [What is CometBFT?](introduction/README.md#what-is-cometbft).
 
-To get started quickly with an example application, see the
-[quick start guide](introduction/quick-start.md).
+To get started quickly with an example application, see the [quick start guide](guides/quick-start.md).
 
 To upgrade from Tendermint Core v0.34.x to CometBFT v0.34.x, please see our
-[upgrading instructions](./introduction/upgrading-from-tm.md).
+[upgrading instructions](./guides/upgrading-from-tm.md).
 
 To learn about application development on CometBFT, see the
 [Application Blockchain Interface](https://github.com/cometbft/cometbft/tree/v0.34.x/spec/abci).

diff --git a/docs/guides/README.md b/docs/guides/README.md
@@ -0,0 +1,15 @@
+---
+order: false
+parent:
+  order: 2
+---
+
+# Guides
+
+- [Installing CometBFT](./install.md)
+- [Quick-start using CometBFT](./quick-start.md)
+- [Upgrading from Tendermint to CometBFT](./upgrading-from-tm.md)
+- [Creating a built-in application in Go](./go-built-in.md)
+- [Creating an external application in Go](./go.md)
+- [Creating an external application in Java](./java.md)
+- [Creating an external application in Kotlin](./kotlin.md)
diff --git a/docs/tutorials/go-built-in.md → docs/guides/go-built-in.md b/docs/tutorials/go-built-in.md → docs/guides/go-built-in.md
diff --git a/docs/tutorials/go.md → docs/guides/go.md b/docs/tutorials/go.md → docs/guides/go.md
diff --git a/docs/introduction/install.md → docs/guides/install.md b/docs/introduction/install.md → docs/guides/install.md
diff --git a/docs/tutorials/java.md → docs/guides/java.md b/docs/tutorials/java.md → docs/guides/java.md
@@ -1,6 +1,6 @@
-<!---
-order: 3
---->
+---
+order: 6
+---
 
 # Creating an application in Java
 

diff --git a/docs/tutorials/kotlin.md → docs/guides/kotlin.md b/docs/tutorials/kotlin.md → docs/guides/kotlin.md
@@ -1,6 +1,6 @@
-<!---
-order: 4
---->
+---
+order: 7
+---
 
 # Creating an application in Kotlin
 

diff --git a/docs/introduction/quick-start.md → docs/guides/quick-start.md b/docs/introduction/quick-start.md → docs/guides/quick-start.md
@@ -11,7 +11,7 @@ works and want to get started right away, continue.
 
 ## Install
 
-See the [install instructions](./install.md).
+See the [install guide](./install.md).
 
 ## Initialization
 
@@ -95,7 +95,7 @@ First create four Ubuntu cloud machines. The following was tested on Digital
 Ocean Ubuntu 16.04 x64 (3GB/1CPU, 20GB SSD). We'll refer to their respective IP
 addresses below as IP1, IP2, IP3, IP4.
 
-Then, `ssh` into each machine and install CometBFT following the [instructions](./install.md).
+Then, `ssh` into each machine and install CometBFT following the [guide](./install.md).
 
 Next, use the `cometbft testnet` command to create four directories of config files (found in `./mytestnet`) and copy each directory to the relevant machine in the cloud, so that each machine has `$HOME/mytestnet/node[0-3]` directory.
 

diff --git a/docs/introduction/upgrading-from-tm.md → docs/guides/upgrading-from-tm.md b/docs/introduction/upgrading-from-tm.md → docs/guides/upgrading-from-tm.md
diff --git a/docs/introduction/README.md b/docs/introduction/README.md
diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md