wushenghua/hapi
1
0
Fork 0
mirror of https://github.com/wu736139669/hapi.git synced 2026-08-05 06:24:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix documentation links to work on GitHub and VitePress

Browse Source 
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
This commit is contained in:
weishu
2026-01-07 15:18:15 +08:00
parent a627b085c8
commit 70242041d5
4 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -22,7 +22,7 @@ npx @twsxtd/hapi server # start the server locally
npx @twsxtd/hapi # run claude code npx @twsxtd/hapi # run claude code
``` ```
Open `http://<server-ip>:3006` and login with the token, if you need to access it remotely, see [Remote access](/guide/installation#remote-access) Open `http://<server-ip>: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) More options: [Quick Start](docs/guide/quick-start.md) | [Installation](docs/guide/installation.md)
docs/guide/faq.md
+3 -3
View File
@@ -48,7 +48,7 @@ It's auto-generated on first server start and saved to `~/.hapi/settings.json`.
### Do you support multiple accounts? ### 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? ### 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: HAPI supports two methods:
1. **PWA Push Notifications** - Enable when prompted, works even when app is closed 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? ### Can I start sessions remotely?
@@ -164,7 +164,7 @@ This checks server connectivity, token validity, agent availability, and more.
| Deployment | Multiple services | Single binary | | Deployment | Multiple services | Single binary |
| Data | Encrypted on server | Never leaves your machine | | 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 ### HAPI vs running Claude Code directly
docs/guide/pwa.md
+2 -2
View File
@@ -99,7 +99,7 @@ HAPI supports push notifications to alert you when agents need attention.
| Ready | Agent finished and awaits input | | Ready | Agent finished and awaits input |
::: tip ::: 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 ## Managing Your PWA
@@ -197,4 +197,4 @@ If PWA doesn't suit your needs, consider the Telegram Mini App:
- Same features as PWA - Same features as PWA
- Integrated notifications - Integrated notifications
See [Installation Guide](/guide/installation#telegram-setup) for Telegram setup. See [Installation Guide](./installation.md#telegram-setup) for Telegram setup.
docs/guide/quick-start.md
+5 -5
View File
@@ -20,7 +20,7 @@ npx @twsxtd/hapi
::: :::
Other install options: [Installation](/guide/installation) Other install options: [Installation](./installation.md)
## Start the server ## Start the server
@@ -52,7 +52,7 @@ Enter your access token to log in.
## Next steps ## Next steps
- [Seamless Handoff](/guide/how-it-works#seamless-handoff) - Switch between terminal and phone seamlessly - [Seamless Handoff](./how-it-works.md#seamless-handoff) - Switch between terminal and phone seamlessly
- [Remote access](/guide/installation#remote-access) - Access HAPI from anywhere - [Remote access](./installation.md#remote-access) - Access HAPI from anywhere
- [Notifications](/guide/installation#telegram-setup) - Set up Telegram notifications - [Notifications](./installation.md#telegram-setup) - Set up Telegram notifications
- [Install the app](/guide/pwa) - Add HAPI to your home screen - [Install the app](./pwa.md) - Add HAPI to your home screen