docs: add Section/Order front-matter so the nav is built from the files (drop a page in, it appears — no code change)

This commit is contained in:
reverse 2026-06-20 06:59:49 +00:00
parent 325a0c84ca
commit 8ad007e091
No known key found for this signature in database
15 changed files with 40 additions and 0 deletions

View file

@ -1,3 +1,6 @@
Section: Reference
Order: 410
# Architecture
Orbit is a small, modular React app. No framework magic — a thin IRC layer feeds a zustand store,

View file

@ -1,3 +1,6 @@
Section: Configuration
Order: 110
# Branding & themes
Everything that ties Orbit to a particular network or brand lives in

View file

@ -1,3 +1,6 @@
Section: Plugins
Order: 210
# Compiled plugins
A quick `.js` plugin (see [Plugin system](/docs/plugins/)) is great for small

View file

@ -1,3 +1,6 @@
Section: Configuration
Order: 100
# config.json reference
Orbit is configured at **runtime** by `config.json`. It is fetched on startup, deep-merged over the

View file

@ -1,3 +1,6 @@
Section: Self-hosting
Order: 300
# Build & deploy
Orbit builds to a **static** `dist/` you can serve from any web server.

View file

@ -1,3 +1,6 @@
Section: Reference
Order: 400
# IRCv3 capabilities
Orbit negotiates the following capabilities when the server advertises them. Most features degrade

View file

@ -1,3 +1,6 @@
Section: Getting started
Order: 10
# Overview
**Orbit** is a modern web client for **IRC** — the open chat protocol that has quietly run

View file

@ -1,3 +1,6 @@
Section: Plugins
Order: 200
# Plugin system
Orbit has a small, **operator-controlled** plugin system. A deployment lists

View file

@ -1,3 +1,6 @@
Section: Self-hosting
Order: 310
# Push-to-deploy
Orbit ships its own self-hosted git workflow: a `git push` runs the tests, builds, and publishes —

View file

@ -1,3 +1,6 @@
Section: Getting started
Order: 20
# Quick start
Run your own Orbit in about a minute.

View file

@ -1,3 +1,5 @@
Order: 10
# Slash commands
Type these in the composer. Anything not starting with `/` is sent as a message.

View file

@ -1,3 +1,5 @@
Order: 20
# mIRC formatting
Orbit renders and lets you compose classic IRC formatting. Use the composer's toolbar (**B** / *I* /

View file

@ -1,3 +1,5 @@
Order: 40
# The #orbit channel & bot
**#orbit** is the project's live IRC channel. A bot named **`Pulsar`** stays connected there and does

View file

@ -1,3 +1,5 @@
Order: 30
# Themes
Switch in **Settings → Appearance**. Four themes ship with Orbit:

View file

@ -1,3 +1,5 @@
Order: 50
# Troubleshooting
## "Connexion fermée" / the socket closes immediately