Skip to content

Commit cc893aa

Browse files
committed
remove preface heading from tutorial and get-started pages
The '## Preface' heading served as a meta-label rather than descriptive content. Removing it allows introductory text to flow naturally after the frontmatter, following standard documentation conventions. Also fix MD029 linting issue in grpc-basic-auth.md (code block indentation within ordered list).
1 parent a8c2848 commit cc893aa

19 files changed

Lines changed: 10 additions & 43 deletions

.mdlrc.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@
2424
# First line in file should be a top level header
2525
exclude_rule 'MD041'
2626

27+
# Allow Multiple headers with the same content
2728
exclude_rule 'MD024'
28-
exclude_rule 'MD029'

content/get-started/become-a-validator.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ they are self-elected through a randomization algorithm based on their stake and
1313

1414
## What Roles do Validators Play?
1515

16-
Validators can run Pactus Core software on their personal computers or remote servers to process transactions, create blocks,
16+
Validators can run Pactus Core software on their personal computers or
17+
remote servers to process transactions, create blocks,
1718
and uphold network security and decentralization.
1819
By staking their own coins, validators contribute to the network's security and are rewarded for their efforts.
1920

content/get-started/configuration.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Pactus Node Configuration
33
weight: 6
44
---
55

6-
## Preface
7-
86
The Pactus node can be configured using a [TOML](https://toml.io/en/) file,
97
which is a simple text format for configuration.
108
This file is automatically created when the node initializes.

content/get-started/pactus-daemon.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Run Pactus in Command Line Mode
33
weight: 3
44
---
55

6-
## Preface
7-
86
Pactus can be run in different modes, including the command-line interface (CLI) and the graphical user interface (GUI).
97
This tutorial will guide you through the steps to run Pactus in CLI mode, suitable for advanced users.
108

content/get-started/pactus-docker.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Run Pactus using Docker
33
weight: 4
44
---
55

6-
## Preface
7-
86
Docker is a tool that simplifies the process of creating, deploying, and running applications using containers.
97
With containers, developers can bundle all the necessary parts of an application, including libraries and dependencies,
108
and deploy them as a single package.

content/get-started/pactus-gui.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Run Pactus in Graphic Mode
33
weight: 2
44
---
55

6-
## Preface
7-
86
Pactus can be run in different modes, including the command-line interface (CLI) and the graphical user interface (GUI).
97
This tutorial will guide you through the steps to run Pactus in GUI mode, suitable for beginner to advanced users.
108

content/tutorials/grpc-basic-auth.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Secure gRPC Using Basic Authentication
33
weight: 6
44
---
55

6-
## Preface
7-
86
The Pactus Blockchain offers a gRPC interface, enabling users to interact with the blockchain
97
and its native wallet. To enhance the security of gRPC APIs, we have implemented a Basic Authentication
108
mechanism based on [bcrypt](https://en.wikipedia.org/wiki/Bcrypt) password hashing.
@@ -77,12 +75,12 @@ To enable Basic Authentication in your Pactus Blockchain configuration, follow t
7775
1. Open the [configuration](https://docs.pactus.org/get-started/configuration/) file in your Pactus directory.
7876
2. Insert the generated user with the hashed password into the `basic_auth` field in the `grpc` section:
7977

80-
```toml
81-
[grpc]
82-
enable = true
83-
enable_wallet = false
84-
listen = "127.0.0.1:50051"
85-
basic_auth = "user:$2a$10$nl6VKEzSENIK5dmzoADgKeTFtCusQxeVCZiXkRzzbyfG.bLpHtrda"
86-
```
78+
```toml
79+
[grpc]
80+
enable = true
81+
enable_wallet = false
82+
listen = "127.0.0.1:50051"
83+
basic_auth = "user:$2a$10$nl6VKEzSENIK5dmzoADgKeTFtCusQxeVCZiXkRzzbyfG.bLpHtrda"
84+
```
8785

8886
3. Restart or run the node to apply this configuration.

content/tutorials/grpc-sign-transactions.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Sign Transactions Using gRPC
33
weight: 5
44
---
55

6-
## Preface
7-
86
The Pactus Blockchain provides a gRPC interface that allows users to interact with the blockchain and native wallet.
97
This is ideal for merchants and users who want to create, sign, and broadcast transactions using their local node.
108
This tutorial will guide you step-by-step on how to use gRPC to sign transactions.

content/tutorials/integration-guide.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Pactus Integration Guide
33
weight: 14
44
---
55

6-
## Preface
7-
86
This guide is intended for developers and infrastructure teams who want to connect
97
their applications directly to the Pactus network, including wallets, exchanges,
108
analytics platforms, staking services, and custom backend systems.

content/tutorials/linux-systemd.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Run Pactus as a Systemd Service
33
weight: 11
44
---
55

6-
## Preface
7-
86
[Systemd](https://en.wikipedia.org/wiki/Systemd) is a system and service manager for Linux that
97
helps manage how programs start up, run, and shut down.
108
It also handles system processes, logging, and basic service monitoring.

0 commit comments

Comments
 (0)