Skip to content

Commit bc1a554

Browse files
andynogmelekes
andynog
and
melekes
authored
docs: Add front matter to ABCI 2.0 tutorial (#3509)
Close: #3508 Tested locally and left hand navigation displays properly with this fix. ![tutorial_navigation](https://github.com/user-attachments/assets/5a02c1ce-44c8-411a-89a2-a6f2bca77c38) #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [X] Updated relevant documentation (`docs/` or `spec/`) and code comments - [X] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec --------- Co-authored-by: Anton Kaliaev <[email protected]>
1 parent 898321c commit bc1a554

17 files changed

+66
-23
lines changed

Diff for: ‎docs/explanation/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
order: 1
2+
order: 3
33
title: CometBFT Explained
4-
description: Explanation
54
parent:
6-
order: 1
5+
order: 3
76
---
87

98
# CometBFT Explained

Diff for: ‎docs/guides/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ order: 2
33
title: CometBFT How-to Guides
44
description: How-to Guides
55
parent:
6-
order: 1
6+
order: 2
77
---
88

99
# How-To Guides

Diff for: ‎docs/references/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ order: 4
33
title: CometBFT Reference Documentation
44
description: References
55
parent:
6-
order: 1
6+
order: 4
77
---
88

99
# Reference Documentation

Diff for: ‎docs/tutorials/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
order: 3
2+
order: 1
33
title: CometBFT Tutorials
44
description: Tutorials
55
parent:

Diff for: ‎docs/tutorials/forum-application/1.abci-intro.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
order: 1
3+
---
4+
15
# Introduction to ABCI 2.0
26

37
`ABCI 2.0` is an updated version of the ABCI (Application Blockchain Interface) from CometBFT. For more details, check the [specification document](https://docs.cometbft.com/v1.0/spec/abci/).

Diff for: ‎docs/tutorials/forum-application/2.intro-forumApp.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
# Forum Application
1+
---
2+
order: 2
3+
---
24

3-
In this tutorial, we will build a Forum application using [ABCI 2.0](https://docs.cometbft.com/v1.0/spec/abci/).
4-
A Forum is an application where people can discuss topics by posting messages and responding to each other.
5-
6-
We will demonstrate the use of `ABCI 2.0` methods like - `CheckTx`, `PrepareProposal`, `ProcessProposal`, `FinalizeBlock`,
7-
`ExtendVote` and `VerifyVoteExtension`
8-
9-
## What does the application do?
5+
## How the Application Works
106

117
For the sake of simplicity, we will not be developing a fully functioning Forum Application. In our tutorial, we will focus
128
on `sender` and `messages` and the censorship of ill-behaved forum users.

Diff for: ‎docs/tutorials/forum-application/3.send-message.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Send Message
1+
---
2+
order: 3
3+
---
4+
5+
# Sending Messages
26

37
**In this section you will learn how a user can send a message on the Forum Application.**
48

Diff for: ‎docs/tutorials/forum-application/4.query-message.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Query Message
1+
---
2+
order: 4
3+
---
4+
5+
# Querying Messages
26

37
**In this section you will learn how users query messages on the forum application.**
48

Diff for: ‎docs/tutorials/forum-application/5.model.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Supported functions
1+
---
2+
order: 5
3+
---
4+
5+
# Defining model types
26

37
**In this section you will learn how a user, messages and db are defined in the Forum Application.**
48

Diff for: ‎docs/tutorials/forum-application/6.main.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Main function
1+
---
2+
order: 6
3+
---
4+
5+
# Running a node
26

37
**The main function in the `forum.go` file is responsible for running the Forum Application blockchain.**
48

Diff for: ‎docs/tutorials/forum-application/7.vote-extension.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
order: 7
3+
---
4+
15
# Vote Extensions
26

37
**In this section you will learn how a node can `ExtendVote` and `VerifyVote` on the forum application.**

Diff for: ‎docs/tutorials/forum-application/8.app.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# App.go
1+
---
2+
order: 8
3+
---
4+
5+
# Application code
26

37
*In this section you will find the code for entire `app.go` file.*
48

Diff for: ‎docs/tutorials/forum-application/9.run-app.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Run Application
1+
---
2+
order: 9
3+
---
4+
5+
# Running the Application
26

37
In previous sections you learned about different ABCI 2.0 methods and how they are used.
48

Diff for: ‎docs/tutorials/forum-application/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
order: 1
3+
parent:
4+
title: Forum Application Tutorial
5+
order: 8
6+
---
7+
8+
# ABCI 2.0 Forum Application Tutorial
9+
10+
In this tutorial, we will build a Forum application using [ABCI 2.0](https://docs.cometbft.com/v1.0/spec/abci/).
11+
A Forum is an application where people can discuss topics by posting messages and responding to each other.
12+
13+
We will demonstrate the use of `ABCI 2.0` methods like - `CheckTx`, `PrepareProposal`, `ProcessProposal`, `FinalizeBlock`,
14+
`ExtendVote` and `VerifyVoteExtension`
15+
16+
Follow the [tutorial](1.abci-intro.md) in order to create a forum application using ABCI 2.0 methods.

Diff for: ‎docs/tutorials/go-built-in.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
order: 2
2+
order: 4
33
---
44

55
# Creating a built-in application in Go

Diff for: ‎docs/tutorials/go.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
order: 1
2+
order: 6
33
---
44

55
# Creating an application in Go

Diff for: ‎docs/tutorials/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
order: 3
2+
order: 1
33
---
44

55
# Install CometBFT

0 commit comments

Comments
 (0)