From aeaa69db163aa48c09c9262d73129d13a05b2fe6 Mon Sep 17 00:00:00 2001 From: Dominik Nakamura Date: Tue, 9 Jan 2024 12:18:35 +0900 Subject: [PATCH] doc(book): remove table of contents The table of contents isn't needed as the automatic "On this page" navigation fulfills the same purpose. --- book/src/guide/creating.md | 2 -- book/src/guide/generating.md | 2 -- book/src/guide/installation.md | 2 -- book/src/ideas.md | 2 -- book/src/reference/schema/arrays.md | 2 -- book/src/reference/schema/attributes.md | 2 -- book/src/reference/schema/constants.md | 2 -- book/src/reference/schema/enums.md | 2 -- book/src/reference/schema/imports.md | 2 -- book/src/reference/schema/index.md | 2 -- book/src/reference/schema/modules.md | 2 -- book/src/reference/schema/references.md | 2 -- book/src/reference/schema/statics.md | 2 -- book/src/reference/schema/structs.md | 2 -- book/src/reference/schema/tuples.md | 2 -- book/src/reference/schema/type-aliases.md | 2 -- book/src/reference/wire-format.md | 2 -- 17 files changed, 34 deletions(-) diff --git a/book/src/guide/creating.md b/book/src/guide/creating.md index 171f914..3ee62a8 100644 --- a/book/src/guide/creating.md +++ b/book/src/guide/creating.md @@ -1,7 +1,5 @@ # Creating schemas -[[toc]] - ## Create the first schema Lets jump right in and discover further details along the way. diff --git a/book/src/guide/generating.md b/book/src/guide/generating.md index d39813e..73fdd19 100644 --- a/book/src/guide/generating.md +++ b/book/src/guide/generating.md @@ -1,7 +1,5 @@ # Generating code -[[toc]] - ## Rust First, make sure you followed the [installation](./installation#rust) instructions, to setup the dependencies in your _Cargo.toml_ properly. diff --git a/book/src/guide/installation.md b/book/src/guide/installation.md index 91a8fa6..de7f3d5 100644 --- a/book/src/guide/installation.md +++ b/book/src/guide/installation.md @@ -1,7 +1,5 @@ # Installation -[[toc]] - ## Command Line Interface The CLI tool is not strictly needed to compile and use Mabo schemas, but it contains several helpful elements like a validator for schema correctness, a formatter and helper for setting up Mabo in your project. diff --git a/book/src/ideas.md b/book/src/ideas.md index 83686ce..dec0ed5 100644 --- a/book/src/ideas.md +++ b/book/src/ideas.md @@ -2,8 +2,6 @@ The following are general ideas for this project, that are not yet implemented or even close to being developed, but definitely on the list of ideas for the future. -[[toc]] - ## Documentation generator Similar to Rust's [rustdoc](https://doc.rust-lang.org/rustdoc/index.html), it would be nice to have a documentation generator built in. The doc comments can be extended to be parsed as Markdown and allow for rich formatting in the docs. diff --git a/book/src/reference/schema/arrays.md b/book/src/reference/schema/arrays.md index 9568b7e..9c17f39 100644 --- a/book/src/reference/schema/arrays.md +++ b/book/src/reference/schema/arrays.md @@ -1,7 +1,5 @@ # Arrays -[[toc]] - ## Schema <<< arrays/basic.mabo diff --git a/book/src/reference/schema/attributes.md b/book/src/reference/schema/attributes.md index 1e17ba7..4cd9f92 100644 --- a/book/src/reference/schema/attributes.md +++ b/book/src/reference/schema/attributes.md @@ -4,8 +4,6 @@ The attributes allow to further apply configuration to elements, while not affec For example, they allow to mark elements as _deprecated_ or define how a certain value is represented in code, off the default variant. -[[toc]] - ## Schema Attributes can come in 3 forms. diff --git a/book/src/reference/schema/constants.md b/book/src/reference/schema/constants.md index 914a4d5..1efc699 100644 --- a/book/src/reference/schema/constants.md +++ b/book/src/reference/schema/constants.md @@ -1,7 +1,5 @@ # Constants -[[toc]] - | Language | Example | | ------------- | ------------------------------- | | Schema / Rust | `const NAME: T = ;` | diff --git a/book/src/reference/schema/enums.md b/book/src/reference/schema/enums.md index 0b958c3..cd5c777 100644 --- a/book/src/reference/schema/enums.md +++ b/book/src/reference/schema/enums.md @@ -1,7 +1,5 @@ # Enums -[[toc]] - ## Basic ### Schema {#basic-schema} diff --git a/book/src/reference/schema/imports.md b/book/src/reference/schema/imports.md index 037e764..0408985 100644 --- a/book/src/reference/schema/imports.md +++ b/book/src/reference/schema/imports.md @@ -1,7 +1,5 @@ # Imports -[[toc]] - ## Schema <<< imports/basic.mabo diff --git a/book/src/reference/schema/index.md b/book/src/reference/schema/index.md index a678d12..38ae4e4 100644 --- a/book/src/reference/schema/index.md +++ b/book/src/reference/schema/index.md @@ -2,8 +2,6 @@ Schemas are an essential part of Mabo. They define the structure of the data, and thus, how to en- and decode to or from the raw bytes. -[[toc]] - ## Type mapping The following describes all the built-in types of the language, together with the equivalent type in each of the supported programming languages. diff --git a/book/src/reference/schema/modules.md b/book/src/reference/schema/modules.md index 0c389a1..1a76329 100644 --- a/book/src/reference/schema/modules.md +++ b/book/src/reference/schema/modules.md @@ -1,7 +1,5 @@ # Modules -[[toc]] - ## Schema <<< modules/basic.mabo diff --git a/book/src/reference/schema/references.md b/book/src/reference/schema/references.md index 3178cfe..84bdec2 100644 --- a/book/src/reference/schema/references.md +++ b/book/src/reference/schema/references.md @@ -1,7 +1,5 @@ # References -[[toc]] - ## Schema <<< references/basic.mabo diff --git a/book/src/reference/schema/statics.md b/book/src/reference/schema/statics.md index d07fdcd..dda6d5e 100644 --- a/book/src/reference/schema/statics.md +++ b/book/src/reference/schema/statics.md @@ -1,3 +1 @@ # Statics - -[[toc]] diff --git a/book/src/reference/schema/structs.md b/book/src/reference/schema/structs.md index 8689e63..ff41111 100644 --- a/book/src/reference/schema/structs.md +++ b/book/src/reference/schema/structs.md @@ -10,8 +10,6 @@ Note that acronyms should be written in strict _CamelCase_, meaning `Html` inste Individual fields in both named and unnamed form are separated by a comma `,`, and it's recommended to even give the last field a trailing comma. This allows for simpler diffs in version control systems. -[[toc]] - ## Named The likely most common form is a named struct. Named means that each element is represented as a field with a name to identify it. diff --git a/book/src/reference/schema/tuples.md b/book/src/reference/schema/tuples.md index d36ca7b..5087050 100644 --- a/book/src/reference/schema/tuples.md +++ b/book/src/reference/schema/tuples.md @@ -1,7 +1,5 @@ # Tuples -[[toc]] - Tuples allow for the definition of a set of types, without having to define an explicit struct for it. These do not have any associated [ID](index.md#identifiers), meaning the order of declaration matters, and any modification to the type definition is generally incompatible. The minimum amount of types in a tuple are **2** and the maximum are **12**. Reasons for this choice are: diff --git a/book/src/reference/schema/type-aliases.md b/book/src/reference/schema/type-aliases.md index a09832d..55f5a80 100644 --- a/book/src/reference/schema/type-aliases.md +++ b/book/src/reference/schema/type-aliases.md @@ -1,7 +1,5 @@ # Type aliases -[[toc]] - | Language | Example | | ------------- | ------------------ | | Schema / Rust | `type A = T;` | diff --git a/book/src/reference/wire-format.md b/book/src/reference/wire-format.md index ba310e2..4800c54 100644 --- a/book/src/reference/wire-format.md +++ b/book/src/reference/wire-format.md @@ -1,7 +1,5 @@ # Wire format -[[toc]] - The wire format takes a lot of inspiration from both [bincode](https://github.com/bincode-org/bincode) and [postcard](https://github.com/jamesmunns/postcard). As tags are involved to identify fields, it takes some ideas from [Protobuf](https://protobuf.dev) and [Cap'n Proto](https://capnproto.org) as well. ## Integers