Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (60 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

90 lines (60 loc) · 2.06 KB

Contributing

We welcome contributions! Whether you spot a typo or want to suggest new content, fork this repo and submit a PR. If you're not comfortable with that process, create an issue or reach out via our community channels.

Local Setup

  1. Install Rust:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

  2. Install mdBook and mdbook-tabs:

    cargo install mdbook mdbook-tabs

  3. Install Node.js (v22+) and script dependencies:

    cd scripts && npm install && cd ..

  4. Clone and serve:

    git clone https://github.com/Start9Labs/docs.git && cd docs
./serve.sh

    This builds all books and serves at http://localhost:3000. For live-reload while editing a single book:

    cd start-os && mdbook serve -p 3001

Writing Docs

All documentation lives under start-os/src/, start-tunnel/src/, or packaging/src/ as Markdown files. The sidebar for each book is defined by its src/SUMMARY.md.

Admonitions

Use mdBook's built-in admonition syntax:

> [!WARNING]
> Do not do this.

> [!NOTE]
> Something helpful.

> [!TIP]
> A useful suggestion.

Custom titles are not supported — > [!WARNING] My Title will break. Put context in the body instead.

Tabs

Use mdbook-tabs for platform-specific content:

{{#tabs global="os"}}
{{#tab name="Linux"}}
Linux instructions here.
{{#endtab}}
{{#tab name="Mac"}}
Mac instructions here.
{{#endtab}}
{{#endtabs}}

Avoid nesting tabs — use separate sections with single-level tabs instead.

Cross-Book Links

Links between books use absolute paths since mdBook only validates intra-book links:

See the [StartTunnel docs](/start-tunnel/).

Within a book, use relative paths as usual.

Submitting Changes

  1. Fork and create a branch
  2. Make your changes
  3. Submit a PR against master