orbit-client-docs/README.md

18 lines
768 B
Markdown

# Orbit — documentation
Source for the Orbit IRC web client documentation, rendered at
**[orbit.tchatou.fr/docs](https://orbit.tchatou.fr/docs/)**.
- **`docs/`** — documentation pages (overview, quick start, configuration,
branding, plugins, self-hosting, IRCv3, architecture)
- **`wiki/`** — user wiki (slash commands, formatting, themes, the `#orbit`
channel, troubleshooting)
- **`faq.md`** — frequently asked questions
Every page is Markdown. Edit a page, commit, and the site serves it.
The Orbit client itself lives at
**[codeberg.org/reversefr/orbit](https://codeberg.org/reversefr/orbit)**.
Pushes to this repository auto-deploy to the live site within ~90s (the
Orbit IRC bot fast-forwards the checkout and announces the update in `#orbit`).