Skip to content

Commit

Permalink
doc(book): remove table of contents
Browse files Browse the repository at this point in the history
The table of contents isn't needed as the automatic "On this page"
navigation fulfills the same purpose.
  • Loading branch information
dnaka91 committed Jan 9, 2024
1 parent ae1cf34 commit aeaa69d
Show file tree
Hide file tree
Showing 17 changed files with 0 additions and 34 deletions.
2 changes: 0 additions & 2 deletions book/src/guide/creating.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Creating schemas

[[toc]]

## Create the first schema

Lets jump right in and discover further details along the way.
Expand Down
2 changes: 0 additions & 2 deletions book/src/guide/generating.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 0 additions & 2 deletions book/src/guide/installation.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 0 additions & 2 deletions book/src/ideas.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/schema/arrays.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Arrays

[[toc]]

## Schema

<<< arrays/basic.mabo
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/schema/attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/schema/constants.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Constants

[[toc]]

| Language | Example |
| ------------- | ------------------------------- |
| Schema / Rust | `const NAME: T = <literal>;` |
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/schema/enums.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Enums

[[toc]]

## Basic

### Schema {#basic-schema}
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/schema/imports.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Imports

[[toc]]

## Schema

<<< imports/basic.mabo
2 changes: 0 additions & 2 deletions book/src/reference/schema/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/schema/modules.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Modules

[[toc]]

## Schema

<<< modules/basic.mabo
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/schema/references.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# References

[[toc]]

## Schema

<<< references/basic.mabo
2 changes: 0 additions & 2 deletions book/src/reference/schema/statics.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# Statics

[[toc]]
2 changes: 0 additions & 2 deletions book/src/reference/schema/structs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/schema/tuples.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/schema/type-aliases.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Type aliases

[[toc]]

| Language | Example |
| ------------- | ------------------ |
| Schema / Rust | `type A = T;` |
Expand Down
2 changes: 0 additions & 2 deletions book/src/reference/wire-format.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit aeaa69d

Please sign in to comment.