Skip to content

Commit

Permalink
feat: add titles for pages
Browse files Browse the repository at this point in the history
  • Loading branch information
cosinlink committed Jul 2, 2024
1 parent 8cbb2ea commit a31a4e0
Show file tree
Hide file tree
Showing 141 changed files with 371 additions and 113 deletions.
4 changes: 3 additions & 1 deletion docs/bc-fusion/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
hide:
- toc

title: BNB Chain Fusion
---

<style>
Expand Down Expand Up @@ -46,4 +48,4 @@ hide:
<div>Participate Governance</div>
<p>Participate in governance on the BSC through Tally</p>
</a>
</div>
</div>
5 changes: 5 additions & 0 deletions docs/bc-fusion/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Overview - BC Fusion
---


# Overview

BNB Beacon Chain is a blockchain developed by the BNB Chain community that implements a vision of a decentralized
Expand Down
4 changes: 2 additions & 2 deletions docs/bnb-greenfield/core-concept/accounts.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Accounts
title: Accounts - BNB Greenfield Core Concepts
description: Greenfield defines its account in the same format as BSC and Ethereum.
keywords: [BNB Greenfield address, BNB Greenfield signature]
order: 1
Expand Down Expand Up @@ -135,4 +135,4 @@ The greenfield-cosmos-sdk provides different options for key storage, each with

The greenfield-cosmos-sdk supports as many sign algorithms as users want, but in Greenfield context, we only
support `eth_secp256k1` and `ed25519`. These algorithms were chosen for their security and compatibility with the
Ethereum and Tendermint ecosystems.
Ethereum and Tendermint ecosystems.
2 changes: 1 addition & 1 deletion docs/bnb-greenfield/core-concept/billing-payment.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Billing and Payment
title: Billing and Payment - BNB Greenfield Core Concepts
order: 4
---

Expand Down
1 change: 1 addition & 0 deletions docs/bnb-greenfield/core-concept/bnb-token-model.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_label: BNB Token Model
title: BNB Token Model - BNB Greenfield Core Concepts
---

# BNB Token Model
Expand Down
2 changes: 1 addition & 1 deletion docs/bnb-greenfield/core-concept/cross-chain/interface.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Primitive Interfaces
title: Primitive Interfaces - BNB Greenfield Cross Chain

---

Expand Down
3 changes: 3 additions & 0 deletions docs/bnb-greenfield/core-concept/cross-chain/mirror.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Resource Mirroring - BNB Greenfield Cross Chain
---
# Resource Mirroring

# Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Cross-Chain Programmability
title: Cross-Chain Programmability - BNB Greenfield Cross Chain
order: 6
---

Expand Down
4 changes: 4 additions & 0 deletions docs/bnb-greenfield/core-concept/cross-chain/sdk.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Smart Contract SDK - BNB Greenfield Cross Chain
---

# Smart Contract SDK

The [Smart Contract SDK](https://github.com/bnb-chain/greenfield-contracts-sdk),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Data Integrity and Availability
title: Data Integrity and Availability - BNB Greenfield Data Storage
order: 6
---

Expand All @@ -24,4 +24,4 @@ Collaboration between Greenfield and storage providers is crucial to ensure data
Stakeholders can trigger challenges in various ways, such as through users or via random events on the Greenfield blockchain.
Following a challenge, [Challenge Verifier](../../introduction.md#challenge-verifier) must conduct an **off-chain audit** of challenged data from storage providers. The Verifier Consortium will vote on the challenge results, and the failed outcomes will reduce the corresponding storage providers' staked BNB. Participants who submitted the challenge and the verifier received rewards for their involvement in this process. Data that failed to pass a challenge will not face another challenge for a specific time to allow storage providers to restore the data.

[Data challenger module](https://github.com/bnb-chain/greenfield/blob/doc-refactor/docs/modules/data-availability-challenge.md) will elaborate further on challenges associated with data availability.
[Data challenger module](https://github.com/bnb-chain/greenfield/blob/doc-refactor/docs/modules/data-availability-challenge.md) will elaborate further on challenges associated with data availability.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Underlying Storage Model
title: Underlying Storage Model - BNB Greenfield Data Storage
order: 8
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Simple Storage Service
title: Simple Storage Service - BNB Greenfield Data Storage
order: 5
---

Expand Down Expand Up @@ -129,4 +129,4 @@ To store an object in Greenfield, the user creates a bucket and then uploads the
* Update: Users can modify Object-related metadata, such as visibility, by sending the `UpdateObjectInfo` transaction to the blockchain.
* Put: Users can use the `PutObject RESTful API` to interact with the SP and upload data to the primary SP.
* Seal: After the PrimarySP and secondary SPs store user data, the PrimarySP will send a `SealObject` transaction to the blockchain, and the status of the object will be updated to Sealed, indicating that the object has been successfully uploaded and can be accessed externally.
* RejectSeal: The PrimarySP can reject sealing the object for any reason by sending `RejectSealObject` transactions to the blockchain, and the corresponding metadata will be deleted on the chain.
* RejectSeal: The PrimarySP can reject sealing the object for any reason by sending `RejectSealObject` transactions to the blockchain, and the corresponding metadata will be deleted on the chain.
2 changes: 1 addition & 1 deletion docs/bnb-greenfield/for-developers/bundle-service.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Bundle Service
title: Bundle Service - BNB Greenfield Develop
description: How to use bundle service to combine small objects.
keywords: [BNB Greenfield, NodeReal, Bundle, Bundle Service]
---
Expand Down
1 change: 1 addition & 0 deletions docs/bnb-greenfield/for-developers/contribute.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_label: Contribute
hide_table_of_contents: true
title: Contribute to BNB Greenfield Documentation
---

# How to Contribute to BNB Greenfield Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/bnb-greenfield/for-developers/get-started-dev.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Quick Guide
title: Quick Guide - BNB Greenfield Develop
description: Quick guide for BNB Greenfield developers. You will understand what you need to build your project.
keywords: [BNB Greenfield development, data storage development]
order: 8
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Contract Entrypoint
title: Contract Entrypoint - BNB Greenfield
order: 7
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: RPC Endpoints
title: RPC Endpoints - BNB Greenfield
#icon: http
order: 3
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
siebar_label: Network Information
Title: Greenfield network information
Title: Greenfield network information - BNB Greenfield
description: Greenfield network information and explorer link
Keywords: [Greenfield Mainnet, Greenfield Testnet, Greenfield explorer]
order: 4
Expand Down
2 changes: 1 addition & 1 deletion docs/bnb-greenfield/for-developers/sdks/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: SDKs
title: SDKs - BNB Greenfield SDK
#icon: stack
#order: 4
#pagination_prev: null
Expand Down
2 changes: 1 addition & 1 deletion docs/bnb-greenfield/for-developers/sdks/sdk-go.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Go SDK Example
title: Go SDK Example - BNB Greenfield SDK
---

# Quickstart
Expand Down
4 changes: 2 additions & 2 deletions docs/bnb-greenfield/for-developers/sdks/sdk-js.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Javascript SDK Example
title: Javascript SDK Example - BNB Greenfield SDK
---

# Quickstart
Expand Down Expand Up @@ -716,4 +716,4 @@ const createObjectTxSimulateInfo = await createObjectTx.simulate({
## API Documentation
- [Greenfield JS SDK Docs](https://docs.bnbchain.org/greenfield-js-sdk/)
- [Greenfield JS SDK Docs](https://docs.bnbchain.org/greenfield-js-sdk/)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Native Access Control
title: Native Access Control - BNB Greenfield Access Control
description: How to use Greenfield Go-SDK library to manage your buckets and objects permission.
keywords: [BNB Greenfield, Access control, Permission]
order: 2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Access Control Management with CLI
title: Access Control Management with CLI - BNB Greenfield Access Control
order: 2
---

Expand Down Expand Up @@ -166,4 +166,4 @@ gnfd-cmd policy rm --groupId 111 --actions get grn:o::website-bucket/index.html

## Conclusion
Overall, the access control management of Greenfield is very powerful and can be used in many scenarios.
It is highly recommended for users to engage in hands-on exploration by trying out different account group management operations and permissioning mechanisms. This will provide a deeper understanding of how BNB Greenfield functions and how to effectively manage and secure data within the decentralized storage system.
It is highly recommended for users to engage in hands-on exploration by trying out different account group management operations and permissioning mechanisms. This will provide a deeper understanding of how BNB Greenfield functions and how to effectively manage and secure data within the decentralized storage system.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Cross Chain Access Control by CMD
title: Cross Chain Access Control by CMD - BNB Greenfield Access Control
description: How to use BSC smart contract as a simple howcase of cross chain program-ability of Greenfield..
keywords: [BNB Greenfield, Access control, Permission]
order: 1
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Cross Chain Access Control by SDK
title: Cross Chain Access Control by SDK - BNB Greenfield Access Control
description: How to use the go-SDK library to transfer permission control over objects to the smart contract on BSC and allowing on-chain management.
keywords: [BNB Greenfield, Access control, Permission]
order: 2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Data Marketplace with Programmable Access Control
title: Data Marketplace with Programmable Access Control - BNB Greenfield App
---
# Data Marketplace with Programmable Access Control

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Simple Tool for File Management
title: Simple Tool for File Management - BNB Greenfield File Management
order: 1
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Dataset Batch operations
title: Dataset Batch operations - BNB Greenfield File Management
order: 2
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Simple Tool for File Management (JS)
title: Simple Tool for File Management (JS) - BNB Greenfield File Management
order: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Resumable Upload/Download Demo
title: Resumable Upload/Download Demo - BNB Greenfield File Management
order: 43
---

Expand Down Expand Up @@ -90,4 +90,4 @@ err = s.Client.FGetObjectResumable(
In the above example, the **`FGetObjectResumable`** function is used to perform a resumable download of a file from the specified bucket and object name. If an error occurs during the download, the subsequent function calls will check the existence and validity of the **`object_{operatoraddress}{getrange}.tmp`** file, and resume the download from the last offset.

### Source code
* [Go-SDK demo](https://github.com/bnb-chain/greenfield-go-sdk/blob/4940fb69df1258fcb232b92e1ed4894ead516583/e2e/e2e_storage_test.go#L452)
* [Go-SDK demo](https://github.com/bnb-chain/greenfield-go-sdk/blob/4940fb69df1258fcb232b92e1ed4894ead516583/e2e/e2e_storage_test.go#L452)
4 changes: 2 additions & 2 deletions docs/bnb-greenfield/for-developers/tutorials/app/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Overview
title: Overview - BNB Greenfield App
order: 1
---

Expand Down Expand Up @@ -38,4 +38,4 @@ One of the primary methods for building dApps with BNB Greenfield is by deployin

* [Basic File Management](./file-management/basic-file-management.md)
* [Resumable Upload & Download](./file-management/resumable-upload/overview.md)
* [Batch operations](./file-management/batch-upload.md)
* [Batch operations](./file-management/batch-upload.md)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Integrating BSC Smart Contracts with Greenfield Projects
title: Integrating BSC Smart Contracts with Greenfield Projects - BNB Greenfield Cross Chain Integration
order: 4
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Resources Mirroring with CLI
title: Resources Mirroring with CLI - BNB Greenfield Cross Chain Integration
order: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Mirroring FAQ
title: Mirroring FAQ - BNB Greenfield Cross Chain Integration
description: A list of BNB Greenfield frequently asks questions about cross-chain resource mirroring.
keywords: [BNB Greenfield Mirror, BNB Greenfield Access Control]
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Basic File Management with CLI
title: Basic File Management with CLI - BNB Greenfield Tutorials
order: 1
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Hosting a Website on Greenfield
title: Hosting a Website on Greenfield - BNB Greenfield Tutorials
order: 1
---

Expand Down Expand Up @@ -152,4 +152,4 @@ Our journey with website development has been filled with ups and downs. We enco

BNB Greenfield's URL format and immutable storage principles require to be mindful of content types and careful when updating files. Despite the minor setbacks, BNB Greenfield remains a valuable platform for deploying websites, offering increased availability, reliability, and quite easy command tools.

Hope you enjoyed it and looking forward to see your websites on BNB Greenfield.
Hope you enjoyed it and looking forward to see your websites on BNB Greenfield.
4 changes: 2 additions & 2 deletions docs/bnb-greenfield/for-developers/tutorials/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Overview
title: Overview - BNB Greenfield Tutorials
order: 1
---

Expand Down Expand Up @@ -36,4 +36,4 @@ The Command Line Interface (CLI) is another native application provided by BNB G

In the following sections, we will delve deeper into each native application, providing step-by-step guides, code snippets, and best practices to empower you to create powerful and innovative dApps without the need for smart contract development.

You can find more information and detailed instructions in the [Building Native dApps](access-control/cmd-access-control.md) section.
You can find more information and detailed instructions in the [Building Native dApps](access-control/cmd-access-control.md) section.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: How to transition from S3 to Greenfield
title: How to transition from S3 to Greenfield
title: How to transition from S3 to Greenfield - BNB Greenfield Develop
description: BNB Greenfield is a blockchain-based decentralized storage solution designed to enhance the decentralization of data ownership and management, allowing users to manage their own data and assets.
---

Expand Down Expand Up @@ -528,4 +528,4 @@ func handleErr(err error, funcName string) {
log.Fatalln("fail to " + funcName + ": " + err.Error())
}
}
```
```
6 changes: 5 additions & 1 deletion docs/bnb-greenfield/getting-started/dcellar.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Dcellar - BNB Greenfield
---

# Use Greenfield in Dcellar

DCellar is a powerful tool that allows users to initiate their decentralized data management journey on the Greenfield platform.
Expand Down Expand Up @@ -229,4 +233,4 @@ Transfer Out will cost you two kinds of fees, all charged by BNB token:
- **Gas fee**: covers the gas cost for sending your transfer on the destination chain.
- **Relayer fee**: paid to relayers for handling cross-chain packets.

Input the amount you want to Transfer Out, Click Transfer Out, your transaction will be sent. You can view your transaction details in [GreenfieldScan](https://greenfieldscan.com/).
Input the amount you want to Transfer Out, Click Transfer Out, your transaction will be sent. You can view your transaction details in [GreenfieldScan](https://greenfieldscan.com/).
2 changes: 1 addition & 1 deletion docs/bnb-greenfield/getting-started/general-faqs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: General FAQ
title: General FAQ - BNB Greenfield
description: A list of BNB Greenfield frequently asks questions.
keywords: [BNB Greenfield token, BNB Greenfield usage]
---
Expand Down
4 changes: 2 additions & 2 deletions docs/bnb-greenfield/getting-started/get-test-bnb.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Faucet
title: Faucet - BNB Greenfield
description: How to get tBNB for Greenfield Testnet
order: 6
---
Expand All @@ -16,4 +16,4 @@ You can claim the test tBNB tokens on BSC Testnet by the faucet, and bridge it t

## Bridge to Greenfield

You can use [BNB Greenfield Bridge](https://greenfield.bnbchain.org/en/bridge) or [DCellar Testnet](https://testnet.dcellar.io/) to transfer BNB from BSC to Greenfield and vice versa. You can follow [How to Transfer In](https://docs.nodereal.io/docs/dcellar-get-started#transfer-in) to bridge tBNBs from BSC Testnet to Greenfield Testnet, and [How to Transfer Out](https://docs.nodereal.io/docs/dcellar-get-started#transfer-out) to bridge tBNBs from Greenfield Testnet to BSC Testnet.
You can use [BNB Greenfield Bridge](https://greenfield.bnbchain.org/en/bridge) or [DCellar Testnet](https://testnet.dcellar.io/) to transfer BNB from BSC to Greenfield and vice versa. You can follow [How to Transfer In](https://docs.nodereal.io/docs/dcellar-get-started#transfer-in) to bridge tBNBs from BSC Testnet to Greenfield Testnet, and [How to Transfer Out](https://docs.nodereal.io/docs/dcellar-get-started#transfer-out) to bridge tBNBs from Greenfield Testnet to BSC Testnet.
2 changes: 1 addition & 1 deletion docs/bnb-greenfield/getting-started/greenfield-command.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Greenfield Command
title: Greenfield Command - BNB Greenfield
description: Guidelines for how to use Greenfield command line tool
order: 7
---
Expand Down
Loading

0 comments on commit a31a4e0

Please sign in to comment.