From 3f1e8c9b6caf1073f234ab9ceacb253511717e3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matev=C5=BE=20Jekovec?= Date: Wed, 4 Oct 2023 11:13:16 +0200 Subject: [PATCH] docs: Fix part/chapter/section usages --- .changelog/5384.doc.md | 1 + docs/README.md | 2 +- docs/consensus/services/registry.md | 2 +- docs/development-setup/building.md | 2 +- docs/development-setup/oasis-net-runner.md | 2 +- 5 files changed, 5 insertions(+), 4 deletions(-) create mode 100644 .changelog/5384.doc.md diff --git a/.changelog/5384.doc.md b/.changelog/5384.doc.md new file mode 100644 index 00000000000..8df4d62b869 --- /dev/null +++ b/.changelog/5384.doc.md @@ -0,0 +1 @@ +docs: Use "chapter" and "section" terms consistently diff --git a/docs/README.md b/docs/README.md index dfd8269bda8..9f732a87e43 100644 --- a/docs/README.md +++ b/docs/README.md @@ -44,7 +44,7 @@ consensus layer only provides information on what state (summarized by a cryptographic hash of a Merklized data structure) is considered canonical at any given point in time. -See the following sections for more details on specific components and their +See the following chapters for more details on specific components and their implementations. * [Consensus Layer](consensus/README.md) diff --git a/docs/consensus/services/registry.md b/docs/consensus/services/registry.md index ed3a78ebd8b..d16692c3541 100644 --- a/docs/consensus/services/registry.md +++ b/docs/consensus/services/registry.md @@ -15,7 +15,7 @@ the [consensus service API documentation]. ## Resources The registry service manages different kinds of resources which are described -from a high level perspective in this section. +from a high level perspective in this chapter. ### Entities and Nodes diff --git a/docs/development-setup/building.md b/docs/development-setup/building.md index c675cfa4a6d..c9cda593362 100644 --- a/docs/development-setup/building.md +++ b/docs/development-setup/building.md @@ -1,6 +1,6 @@ # Building -This section contains a description of steps required to build Oasis Core. +This chapter contains a description of steps required to build Oasis Core. Before proceeding, make sure to look at the [prerequisites] required for running an Oasis Core environment. diff --git a/docs/development-setup/oasis-net-runner.md b/docs/development-setup/oasis-net-runner.md index d968c9e1a17..6bb48bb31dd 100644 --- a/docs/development-setup/oasis-net-runner.md +++ b/docs/development-setup/oasis-net-runner.md @@ -112,7 +112,7 @@ sysctl kernel.unprivileged_userns_clone=1 This could also happen if you are running in a Docker container without specifying additional options at startup. See the [Using the Development Docker -Image] section for details. +Image] section of the Prerequisites for details. [sandboxing]: ../runtime/README.md#runtimes