orbit/orbit-client-docs
orbit/orbit-client-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: use absolute URLs for internal doc links so they work off-site (e.g. the repo view), not just on orbit.tchatou.fr

Browse source
This commit is contained in:
reverse 2026-06-20 07:10:22 +00:00
parent 8ad007e091
commit 4144f5f125
No known key found for this signature in database
11 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/architecture.md
View file

@ -40,4 +40,4 @@ src/
## Quality
Vitest unit tests cover the pure modules (parser, casemap, masking). Lint + test + build run in CI,
and the self-hosted [push-to-deploy](/docs/push-to-deploy/) gates on the same.
and the self-hosted [push-to-deploy](https://orbit.tchatou.fr/docs/push-to-deploy/) gates on the same.

4
docs/branding.md
View file

@ -4,7 +4,7 @@ Order: 110
# Branding & themes
Everything that ties Orbit to a particular network or brand lives in
[`config.json`](/docs/config/) under `branding` and `defaults` — no code changes, no rebuild.
[`config.json`](https://orbit.tchatou.fr/docs/config/) under `branding` and `defaults` — no code changes, no rebuild.
## Rebrand
@ -39,7 +39,7 @@ Set the default for new users:
{ "defaults": { "theme": "dark" } }
```
Users can switch any time in **Settings → Appearance**. See the [Themes wiki page](/wiki/themes/).
Users can switch any time in **Settings → Appearance**. See the [Themes wiki page](https://orbit.tchatou.fr/wiki/themes/).
## Feature flags

2
docs/compiled-plugins.md
View file

@ -3,7 +3,7 @@ Order: 210
# Compiled plugins
A quick `.js` plugin (see [Plugin system](/docs/plugins/)) is great for small
A quick `.js` plugin (see [Plugin system](https://orbit.tchatou.fr/docs/plugins/)) is great for small
things. For anything substantial — real components with state and hooks — build
the plugin like a normal project and compile it down to **one droppable file**: a
compiled, externalized-React plugin model.

2
docs/deploy.md
View file

@ -35,4 +35,4 @@ On each deploy, bump the cache version in `public/sw.js` (`const CACHE = 'app-vN
calls `skipWaiting()` + `clients.claim()` and fires `controllerchange`, so existing PWA installs
auto-reload to the new build.
For an automated pipeline, see [Push-to-deploy](/docs/push-to-deploy/).
For an automated pipeline, see [Push-to-deploy](https://orbit.tchatou.fr/docs/push-to-deploy/).

2
docs/ircv3.md
View file

@ -37,4 +37,4 @@ gracefully if a cap is missing, so it works on any compliant IRCv3 server.
| `draft/pre-away` | Set away during registration. |
| `draft/webpush` | Push notifications while the tab is closed (VAPID). |
You can list the live set any time by typing `!caps` to the bot in [#orbit](/wiki/orbit-channel/).
You can list the live set any time by typing `!caps` to the bot in [#orbit](https://orbit.tchatou.fr/wiki/orbit-channel/).

10
docs/overview.md
View file

@ -14,19 +14,19 @@ network** and **rebranded** from a single `config.json` — without recompiling.
- **Full IRCv3.** Orbit negotiates 24 capabilities — SASL, message-tags, reactions, typing
indicators, read-markers, multi-line messages, server-side history, account registration, and
Web Push. See [IRCv3 capabilities](/docs/ircv3/).
Web Push. See [IRCv3 capabilities](https://orbit.tchatou.fr/docs/ircv3/).
- **Pluggable at runtime.** A static `config.json` is fetched on startup and sets the server,
channels, branding, themes and feature flags. One build can serve any community. See
[config.json reference](/docs/config/).
[config.json reference](https://orbit.tchatou.fr/docs/config/).
- **Installable PWA.** Mobile-first layout, offline app shell, and notifications when the tab is
closed.
- **Self-hostable.** A static build behind any web server. The project even runs its own git
server with [push-to-deploy](/docs/push-to-deploy/).
server with [push-to-deploy](https://orbit.tchatou.fr/docs/push-to-deploy/).
- **Free software.** AGPL-3.0 — use it, modify it, self-host it.
## Tech
React 19 · TypeScript · Vite · zustand. Tested with Vitest, linted, and built in CI. The codebase
is a clean modular tree — see [Architecture](/docs/architecture/).
is a clean modular tree — see [Architecture](https://orbit.tchatou.fr/docs/architecture/).
> New here? Jump to the [Quick start](/docs/quick-start/) to run your own in a minute.
> New here? Jump to the [Quick start](https://orbit.tchatou.fr/docs/quick-start/) to run your own in a minute.

4
docs/plugins.md
View file

@ -14,7 +14,7 @@ add UI in predefined slots.
## Enabling plugins
Add script URLs to `plugins` in [`config.json`](/docs/config/):
Add script URLs to `plugins` in [`config.json`](https://orbit.tchatou.fr/docs/config/):
```json
{ "plugins": ["/app/plugins/orbit-demo.js"] }
@ -42,7 +42,7 @@ Orbit.plugin('my-plugin', (orbit, log) => {
```
For anything substantial — real components with state — build a compiled plugin
instead. See **[Compiled plugins](/docs/compiled-plugins/)**.
instead. See **[Compiled plugins](https://orbit.tchatou.fr/docs/compiled-plugins/)**.
## The `Orbit` API

2
docs/push-to-deploy.md
View file

@ -38,4 +38,4 @@ done
## Bonus: IRC announcements
The same hook hands the commit list to a small bot that posts a GitHub-style summary to the
project's IRC channel. See [The #orbit channel & bot](/wiki/orbit-channel/).
project's IRC channel. See [The #orbit channel & bot](https://orbit.tchatou.fr/wiki/orbit-channel/).

8
docs/quick-start.md
View file

@ -40,10 +40,10 @@ npm run build # → dist/
```
Serve the static `dist/` behind any web server (commonly under `/app/`). See
[Build & deploy](/docs/deploy/) for nginx and service-worker details.
[Build & deploy](https://orbit.tchatou.fr/docs/deploy/) for nginx and service-worker details.
## Next steps
- [config.json reference](/docs/config/) — every option.
- [Branding & themes](/docs/branding/) — make it yours.
- [IRCv3 capabilities](/docs/ircv3/) — what works on your server.
- [config.json reference](https://orbit.tchatou.fr/docs/config/) — every option.
- [Branding & themes](https://orbit.tchatou.fr/docs/branding/) — make it yours.
- [IRCv3 capabilities](https://orbit.tchatou.fr/docs/ircv3/) — what works on your server.

6
faq.md
View file

@ -12,12 +12,12 @@ reserve a nick, host images, or get push notifications while closed.
## What servers does it work with?
Any **IRCv3** server with a WebSocket listener — InspIRCd, Ergo, and others. The more capabilities
the server supports, the more features light up. See [IRCv3 capabilities](/docs/ircv3/).
the server supports, the more features light up. See [IRCv3 capabilities](https://orbit.tchatou.fr/docs/ircv3/).
## Can I use it for my own network?
Absolutely — that's the point. Re-point it at your server and rebrand it entirely from one
[`config.json`](/docs/config/), no rebuild. See [Branding & themes](/docs/branding/).
[`config.json`](https://orbit.tchatou.fr/docs/config/), no rebuild. See [Branding & themes](https://orbit.tchatou.fr/docs/branding/).
## Does it work on mobile?
@ -38,7 +38,7 @@ In-tab alerts and sounds work everywhere. **Push** notifications while the tab i
## Can I self-host it?
Yes — it's a static build behind any web server. The project even runs its own git server with
[push-to-deploy](/docs/push-to-deploy/). Start with the [Quick start](/docs/quick-start/).
[push-to-deploy](https://orbit.tchatou.fr/docs/push-to-deploy/). Start with the [Quick start](https://orbit.tchatou.fr/docs/quick-start/).
## How do I report a bug or contribute?

2
wiki/themes.md
View file

@ -11,7 +11,7 @@ Switch in **Settings → Appearance**. Four themes ship with Orbit:
- **yomIRC dark** — the retro skin in a deep dark palette with a teal accent.
Deployers can set the **default theme** for new users in
[`config.json`](/docs/config/) → `defaults.theme` (`light` · `dark` · `yomirc` · `yomirc-dark`).
[`config.json`](https://orbit.tchatou.fr/docs/config/) → `defaults.theme` (`light` · `dark` · `yomirc` · `yomirc-dark`).
Other appearance options in Settings: