From 4144f5f125bb049bddb86a3fc9fbd16eb3141fbd Mon Sep 17 00:00:00 2001 From: reverse Date: Sat, 20 Jun 2026 07:10:22 +0000 Subject: [PATCH] docs: use absolute URLs for internal doc links so they work off-site (e.g. the repo view), not just on orbit.tchatou.fr --- docs/architecture.md | 2 +- docs/branding.md | 4 ++-- docs/compiled-plugins.md | 2 +- docs/deploy.md | 2 +- docs/ircv3.md | 2 +- docs/overview.md | 10 +++++----- docs/plugins.md | 4 ++-- docs/push-to-deploy.md | 2 +- docs/quick-start.md | 8 ++++---- faq.md | 6 +++--- wiki/themes.md | 2 +- 11 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 1d20660..7e3fbe7 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -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. diff --git a/docs/branding.md b/docs/branding.md index cb5866b..8598f2d 100644 --- a/docs/branding.md +++ b/docs/branding.md @@ -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 diff --git a/docs/compiled-plugins.md b/docs/compiled-plugins.md index 9f3d943..da712bf 100644 --- a/docs/compiled-plugins.md +++ b/docs/compiled-plugins.md @@ -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. diff --git a/docs/deploy.md b/docs/deploy.md index 662133c..48aa8c9 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -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/). diff --git a/docs/ircv3.md b/docs/ircv3.md index dae77f4..5c109d8 100644 --- a/docs/ircv3.md +++ b/docs/ircv3.md @@ -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/). diff --git a/docs/overview.md b/docs/overview.md index f34f153..5dbc628 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -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. diff --git a/docs/plugins.md b/docs/plugins.md index 41ed32e..c1745b4 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -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 diff --git a/docs/push-to-deploy.md b/docs/push-to-deploy.md index daa1536..0169bb6 100644 --- a/docs/push-to-deploy.md +++ b/docs/push-to-deploy.md @@ -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/). diff --git a/docs/quick-start.md b/docs/quick-start.md index cf34f3e..ae2ff4e 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -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. diff --git a/faq.md b/faq.md index 012e8a4..2ef2eb8 100644 --- a/faq.md +++ b/faq.md @@ -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? diff --git a/wiki/themes.md b/wiki/themes.md index 8e074a1..d7075c3 100644 --- a/wiki/themes.md +++ b/wiki/themes.md @@ -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: