Skip to content

Commit

Permalink
README.md: Define part, chapter and section
Browse files Browse the repository at this point in the history
  • Loading branch information
matevz committed Oct 6, 2023
1 parent 8b3a1fc commit 350ee0e
Showing 1 changed file with 10 additions and 8 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

0 comments on commit 350ee0e

Please sign in to comment.