Skip to content

Commit

Permalink
Reorganize existing guides (cometbft#492)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
lasarojc authored Mar 10, 2023
1 parent 24040f5 commit fa98b5e
Show file tree
Hide file tree
Showing 8 changed files with 322 additions and 337 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ 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.md).

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 learn about application development on CometBFT, see the [Application Blockchain Interface](https://github.com/cometbft/cometbft/tree/main/spec/abci).

Expand Down
2 changes: 2 additions & 0 deletions docs/tutorials/README.md → docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@ parent:

# Guides

- [Installing CometBFT](./install.md)
- [Quick-start using CometBFT](./quick-start.md)
- [Creating a built-in application in Go](./go-built-in.md)
- [Creating an external application in Go](./go.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
325 changes: 318 additions & 7 deletions docs/introduction/README.md

Large diffs are not rendered by default.

328 changes: 0 additions & 328 deletions docs/introduction/what-is-cometbft.md

This file was deleted.

0 comments on commit fa98b5e

Please sign in to comment.