Skip to content

Commit

Permalink
Merge pull request #525 from oasisprotocol/matevz/feature/part-chapte…
Browse files Browse the repository at this point in the history
…r-section

docs: Use part, chapter and section consistently
  • Loading branch information
matevz authored Oct 6, 2023
2 parents 8b3a1fc + 9610c99 commit b6f1354
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 22 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,20 +86,22 @@ link checker in `package.json`._
### Documentation structure

`docs` folder contains markdown files of the documentation. Each subfolder
represents one of the top-level chapter (general, node, dApp, paratime, core
etc.).
represents a documentation **part** (general, node, dApp, paratime, core etc.).
Each markdown file inside a part corresponds to a **chapter** (subchapter for a
markdown file inside a subfolder) and each subtitle of a chapter is called a
**section** (subsection etc.).

Some top-level chapter may contain markdown files or folders hosted and
maintained in other Oasis repositories (e.g. oasis-sdk, oasis-core). In this
case, a complete git submodule for the repository is cloned inside `external`
folder. Then, symbolic links to specific markdown files or folders are added
inside `docs` accordingly.
Some parts may contain markdown files or folders hosted and maintained in other
Oasis repositories (e.g. oasis-sdk, oasis-core). In this case, a complete git
submodule for the repository is cloned inside `external` folder. Then, symbolic
links to specific markdown files or folders are added inside `docs`
accordingly.

While all markdown files inside `docs` are compiled, not all files may be
reachable via sidebars directly. Each top-level chapter defines own
sidebar structure inside their `sidebarChapterName.js` file.

Nouns, adjectives and verbs in section titles should be capitalized.
Nouns, adjectives and verbs in the titles should be capitalized.

### index.md, README.md, overview.md

Expand Down
24 changes: 13 additions & 11 deletions docs/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ import {findSidebarItem} from '@site/src/sidebarUtils';

## Use Oasis

The introductory section contains general overview of the Oasis Network such as
This introductory part contains general overview of the Oasis Network such as
the distinction between the consensus layer and different ParaTimes. It
also covers wallets and other tools for managing your assets across the Oasis
chains and how to use unique Oasis features.

<DocCardList items={[
findSidebarItem('/general/oasis-network/'),
findSidebarItem('/general/manage-tokens/'),
findSidebarItem('/general/manage-tokens/cli/'),
]} />

## Create dApp
Expand All @@ -25,7 +26,7 @@ encryption**. The Oasis team also prepared a set of libraries called the
[Oasis Privacy Layer] to **bridge existing dApps running on other chains** to
use the unique Sapphire's confidentiality.

The section also covers other ParaTimes such as the non-confidential
The part also covers other ParaTimes such as the non-confidential
[Oasis Emerald] and Wasm-compatible, confidential [Oasis Cipher].

<DocCardList items={[
Expand Down Expand Up @@ -54,7 +55,7 @@ developers and how to contribute to the network.

## Run Node

If you want to run your own Oasis node, the following section will provide you
If you want to run your own Oasis node, this part will provide you
with guides on the current Mainnet and Testnet network parameters and how to
set up your node, let it be a validator node, perhaps running a ParaTime or
just a simple client node for your server to submit transactions and perform
Expand All @@ -69,22 +70,23 @@ queries on the network.

## Build ParaTimes

Apart from Emerald, Cipher, Sapphire and the Key manager ParaTimes, developers
can learn how to write, compile, sign and deploy their own ParaTimes on the
Oasis Network.
Apart from the Sapphire, Emerald, Cipher and the Key manager ParaTimes,
you can also write, compile, sign and deploy your own ParaTime on the Oasis
Network. This part describes the knobs you need to use to do so.

<DocCard item={findSidebarItem('/paratime/')} />

## Develop Core

Whether you want to contribute your code to the core components of the Oasis
Network or just learn more about the Oasis core, this is the place for you.
Network or just learn more about the Oasis consensus layer and other core
components, this is the part for you.

<DocCard item={ findSidebarItem('/core/') } />

Development of interoperable Oasis network components are made by consensus.
Similar to the Ethereum's ERC/EIP mechanism, Oasis follows Architectural
Decision Records (ADRs) which are first proposed, voted on and can then be
implemented, if accepted.
Additions or changes to the interoperable Oasis network components are always
made with consensus. Similar to the Ethereum's ERC/EIP mechanism Oasis follows
formal Architectural Decision Records (ADRs) which are first proposed, voted on
and finally implemented, if accepted.

<DocCard item={ findSidebarItem('/adrs') } />
1 change: 1 addition & 0 deletions docs/general/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ basic tools for you to get started.
<DocCardList items={[
findSidebarItem('/general/oasis-network/'),
findSidebarItem('/general/manage-tokens/'),
findSidebarItem('/general/manage-tokens/cli/'),
]} />
2 changes: 1 addition & 1 deletion docs/node/run-your-node/non-validator-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This guide will cover setting up your non-validator node for the Oasis Network.

## Prerequisites

Before following this guide, make sure you've followed the [Prerequisites](prerequisites) section and have the Oasis Node binary installed on your systems.
Before following this guide, make sure you've followed the [Prerequisites](prerequisites) chapter and have the Oasis Node binary installed on your systems.

### Creating a Working Directory

Expand Down
2 changes: 1 addition & 1 deletion docs/node/testnet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The Oasis Node is part of the Oasis Core release.

## ParaTimes

This section contains parameters for various ParaTimes known to be deployed on the Testnet. Similar to the Testnet, these may be subject to frequent version upgrades and/or state resets.
This chapter contains parameters for various ParaTimes known to be deployed on the Testnet. Similar to the Testnet, these may be subject to frequent version upgrades and/or state resets.

### Cipher

Expand Down
2 changes: 1 addition & 1 deletion external/oasis-sdk
Submodule oasis-sdk updated 288 files

0 comments on commit b6f1354

Please sign in to comment.