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:
parent
325a0c84ca
commit
8ad007e091
15 changed files with 40 additions and 0 deletions
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Reference
|
||||||
|
Order: 410
|
||||||
|
|
||||||
# Architecture
|
# Architecture
|
||||||
|
|
||||||
Orbit is a small, modular React app. No framework magic — a thin IRC layer feeds a zustand store,
|
Orbit is a small, modular React app. No framework magic — a thin IRC layer feeds a zustand store,
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Configuration
|
||||||
|
Order: 110
|
||||||
|
|
||||||
# Branding & themes
|
# Branding & themes
|
||||||
|
|
||||||
Everything that ties Orbit to a particular network or brand lives in
|
Everything that ties Orbit to a particular network or brand lives in
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Plugins
|
||||||
|
Order: 210
|
||||||
|
|
||||||
# Compiled plugins
|
# Compiled plugins
|
||||||
|
|
||||||
A quick `.js` plugin (see [Plugin system](/docs/plugins/)) is great for small
|
A quick `.js` plugin (see [Plugin system](/docs/plugins/)) is great for small
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Configuration
|
||||||
|
Order: 100
|
||||||
|
|
||||||
# config.json reference
|
# config.json reference
|
||||||
|
|
||||||
Orbit is configured at **runtime** by `config.json`. It is fetched on startup, deep-merged over the
|
Orbit is configured at **runtime** by `config.json`. It is fetched on startup, deep-merged over the
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Self-hosting
|
||||||
|
Order: 300
|
||||||
|
|
||||||
# Build & deploy
|
# Build & deploy
|
||||||
|
|
||||||
Orbit builds to a **static** `dist/` you can serve from any web server.
|
Orbit builds to a **static** `dist/` you can serve from any web server.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Reference
|
||||||
|
Order: 400
|
||||||
|
|
||||||
# IRCv3 capabilities
|
# IRCv3 capabilities
|
||||||
|
|
||||||
Orbit negotiates the following capabilities when the server advertises them. Most features degrade
|
Orbit negotiates the following capabilities when the server advertises them. Most features degrade
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Getting started
|
||||||
|
Order: 10
|
||||||
|
|
||||||
# Overview
|
# Overview
|
||||||
|
|
||||||
**Orbit** is a modern web client for **IRC** — the open chat protocol that has quietly run
|
**Orbit** is a modern web client for **IRC** — the open chat protocol that has quietly run
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Plugins
|
||||||
|
Order: 200
|
||||||
|
|
||||||
# Plugin system
|
# Plugin system
|
||||||
|
|
||||||
Orbit has a small, **operator-controlled** plugin system. A deployment lists
|
Orbit has a small, **operator-controlled** plugin system. A deployment lists
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Self-hosting
|
||||||
|
Order: 310
|
||||||
|
|
||||||
# Push-to-deploy
|
# Push-to-deploy
|
||||||
|
|
||||||
Orbit ships its own self-hosted git workflow: a `git push` runs the tests, builds, and publishes —
|
Orbit ships its own self-hosted git workflow: a `git push` runs the tests, builds, and publishes —
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,6 @@
|
||||||
|
Section: Getting started
|
||||||
|
Order: 20
|
||||||
|
|
||||||
# Quick start
|
# Quick start
|
||||||
|
|
||||||
Run your own Orbit in about a minute.
|
Run your own Orbit in about a minute.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
|
Order: 10
|
||||||
|
|
||||||
# Slash commands
|
# Slash commands
|
||||||
|
|
||||||
Type these in the composer. Anything not starting with `/` is sent as a message.
|
Type these in the composer. Anything not starting with `/` is sent as a message.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
|
Order: 20
|
||||||
|
|
||||||
# mIRC formatting
|
# mIRC formatting
|
||||||
|
|
||||||
Orbit renders and lets you compose classic IRC formatting. Use the composer's toolbar (**B** / *I* /
|
Orbit renders and lets you compose classic IRC formatting. Use the composer's toolbar (**B** / *I* /
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
|
Order: 40
|
||||||
|
|
||||||
# The #orbit channel & bot
|
# The #orbit channel & bot
|
||||||
|
|
||||||
**#orbit** is the project's live IRC channel. A bot named **`Pulsar`** stays connected there and does
|
**#orbit** is the project's live IRC channel. A bot named **`Pulsar`** stays connected there and does
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
|
Order: 30
|
||||||
|
|
||||||
# Themes
|
# Themes
|
||||||
|
|
||||||
Switch in **Settings → Appearance**. Four themes ship with Orbit:
|
Switch in **Settings → Appearance**. Four themes ship with Orbit:
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
|
Order: 50
|
||||||
|
|
||||||
# Troubleshooting
|
# Troubleshooting
|
||||||
|
|
||||||
## "Connexion fermée" / the socket closes immediately
|
## "Connexion fermée" / the socket closes immediately
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue