ShortMesh Documentation

This repo uses mdBook to build and serve the docs.

Prerequisites

Install the mdbook binary (one-time):

curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xz -C ~/.local/bin/

Make sure ~/.local/bin is on your $PATH.

Start the dev server

mdbook serve --open

Runs a live-reload server at http://localhost:3000. Any file you save in src/ rebuilds instantly.

To just build the static output without serving:

mdbook build
# output goes to ./book/

Adding a page

1. Create a new Markdown file anywhere under src/:

   src/some-topic.md
   

2. Register it in src/SUMMARY.md:

   - [Some Topic](./some-topic.md)

The entry in SUMMARY.md is what makes a page appear in the sidebar — files not listed there are ignored.

Organizing pages into groups

Use nested lists in SUMMARY.md to create collapsible sections:

# Summary

- [Introduction](./introduction.md)

# Getting Started
- [Installation](./getting-started/installation.md)
- [Quick Start](./getting-started/quickstart.md)

# API Reference
- [Overview](./api/overview.md)
  - [Endpoints](./api/endpoints.md)
  - [Auth](./api/auth.md)

• Top-level # Heading lines become non-clickable section dividers in the sidebar.
• Indented entries become nested children under the parent page.
• Mirror the structure in src/ with subdirectories to keep things tidy:

  src/
  ├── SUMMARY.md
  ├── introduction.md
  ├── getting-started/
  │   ├── installation.md
  │   └── quickstart.md
  └── api/
      ├── overview.md
      ├── endpoints.md
      └── auth.md
  

Config

book.toml at the root controls the book title, author, source directory, and optional plugins. See the mdBook docs for all options.