From 70242041d5399385b0620ec1788ab3c6b5276c8e Mon Sep 17 00:00:00 2001 From: weishu Date: Wed, 7 Jan 2026 15:18:15 +0800 Subject: [PATCH] docs: fix documentation links to work on GitHub and VitePress Use relative paths with .md extension for docs/guide/*.md files and relative paths in README.md to support both GitHub rendering and VitePress website (which has base: '/docs/'). Fixes #36 --- README.md | 2 +- docs/guide/faq.md | 6 +++--- docs/guide/pwa.md | 4 ++-- docs/guide/quick-start.md | 10 +++++----- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f1c04d85..f4f21c32 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ npx @twsxtd/hapi server # start the server locally npx @twsxtd/hapi # run claude code ``` -Open `http://:3006` and login with the token, if you need to access it remotely, see [Remote access](/guide/installation#remote-access) +Open `http://:3006` and login with the token, if you need to access it remotely, see [Remote access](docs/guide/installation.md#remote-access) More options: [Quick Start](docs/guide/quick-start.md) | [Installation](docs/guide/installation.md) diff --git a/docs/guide/faq.md b/docs/guide/faq.md index b48a94d5..979d0cb3 100644 --- a/docs/guide/faq.md +++ b/docs/guide/faq.md @@ -48,7 +48,7 @@ It's auto-generated on first server start and saved to `~/.hapi/settings.json`. ### Do you support multiple accounts? -Yes. We support lightweight multi-account access via namespaces for shared team servers. See [Namespace (Advanced)](/guide/namespace). +Yes. We support lightweight multi-account access via namespaces for shared team servers. See [Namespace (Advanced)](./namespace.md). ### Can I use HAPI without Telegram? @@ -68,7 +68,7 @@ Yes. Telegram is optional. You can use the web app directly in any browser or in HAPI supports two methods: 1. **PWA Push Notifications** - Enable when prompted, works even when app is closed -2. **Telegram Bot** - See [Telegram Setup](/guide/installation#telegram-setup) +2. **Telegram Bot** - See [Telegram Setup](./installation.md#telegram-setup) ### Can I start sessions remotely? @@ -164,7 +164,7 @@ This checks server connectivity, token validity, agent availability, and more. | Deployment | Multiple services | Single binary | | Data | Encrypted on server | Never leaves your machine | -See [Why HAPI](/guide/why-hapi) for detailed comparison. +See [Why HAPI](./why-hapi.md) for detailed comparison. ### HAPI vs running Claude Code directly diff --git a/docs/guide/pwa.md b/docs/guide/pwa.md index c91cc3c2..5b6dfd58 100644 --- a/docs/guide/pwa.md +++ b/docs/guide/pwa.md @@ -99,7 +99,7 @@ HAPI supports push notifications to alert you when agents need attention. | Ready | Agent finished and awaits input | ::: tip -If push notifications don't work in your region (e.g., FCM unavailable), use [Telegram integration](/guide/installation#telegram-setup) instead. +If push notifications don't work in your region (e.g., FCM unavailable), use [Telegram integration](./installation.md#telegram-setup) instead. ::: ## Managing Your PWA @@ -197,4 +197,4 @@ If PWA doesn't suit your needs, consider the Telegram Mini App: - Same features as PWA - Integrated notifications -See [Installation Guide](/guide/installation#telegram-setup) for Telegram setup. +See [Installation Guide](./installation.md#telegram-setup) for Telegram setup. diff --git a/docs/guide/quick-start.md b/docs/guide/quick-start.md index 439c0b07..bf43e372 100644 --- a/docs/guide/quick-start.md +++ b/docs/guide/quick-start.md @@ -20,7 +20,7 @@ npx @twsxtd/hapi ::: -Other install options: [Installation](/guide/installation) +Other install options: [Installation](./installation.md) ## Start the server @@ -52,7 +52,7 @@ Enter your access token to log in. ## Next steps -- [Seamless Handoff](/guide/how-it-works#seamless-handoff) - Switch between terminal and phone seamlessly -- [Remote access](/guide/installation#remote-access) - Access HAPI from anywhere -- [Notifications](/guide/installation#telegram-setup) - Set up Telegram notifications -- [Install the app](/guide/pwa) - Add HAPI to your home screen +- [Seamless Handoff](./how-it-works.md#seamless-handoff) - Switch between terminal and phone seamlessly +- [Remote access](./installation.md#remote-access) - Access HAPI from anywhere +- [Notifications](./installation.md#telegram-setup) - Set up Telegram notifications +- [Install the app](./pwa.md) - Add HAPI to your home screen