Skip to content

Commit 7ebb856

Browse files
committed
docs: fix various issues of the docs
1 parent 5390e59 commit 7ebb856

7 files changed

Lines changed: 11 additions & 19 deletions

File tree

_changelog/2.4.0-upgrade.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ php hawki clear-cache
5151
php hawki models sync --force
5252
```
5353

54-
See [AI Models & Tools](/architecture/10.2-AI%20Models%20and%20Tools) for the full architecture details.
54+
See [AI Models & Tools](/Configuration/AI-Models-and-Tools) for the full architecture details.
5555

5656
### 5. Tools system
5757

58-
Built-in function tools are synced to the database automatically after migration. To add MCP servers or manage tool–model assignments, refer to [AI Models & Tools](/architecture/10.2-AI%20Models%20and%20Tools).
58+
Built-in function tools are synced to the database automatically after migration. To add MCP servers or manage tool–model assignments, refer to [AI Models & Tools](/Configuration/AI-Models-and-Tools).
5959

6060
### 6. New `.env` variables
6161

_changelog/2.4.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
### Quality of Life
1919

2020
- Allow `DB_BACKUP_INTERVAL` to be set to `never`, to disable automatic database backups. This is useful for users who want to manage their own backup strategy or do not want to use the built-in backup functionality.
21-
- Adds a new `DB_BACKUP_INTERVAL_ARGS` environment variable, that works in tandem with `DB_BACKUP_INTERVAL`, to allow more fine-grained control over the database backup process. Read more in the [Dot Env documentation](../_documentation/3-architecture/10-dot%20Env.md)
22-
- Adds new `APP_TRUSTED_PROXIES` environment variable, to the app to run behind a reverse proxy with SSL termination. Read more in the [Dot Env documentation](../_documentation/3-architecture/10-dot%20Env.md#APP_TRUSTED_PROXIES)
21+
- Adds a new `DB_BACKUP_INTERVAL_ARGS` environment variable, that works in tandem with `DB_BACKUP_INTERVAL`, to allow more fine-grained control over the database backup process. Read more in the [Dot Env documentation](../_documentation/200-Configuration/100-Dot-Env.md)
22+
- Adds new `APP_TRUSTED_PROXIES` environment variable, to the app to run behind a reverse proxy with SSL termination. Read more in the [Dot Env documentation](../_documentation/200-Configuration/100-Dot-Env.md#APP_TRUSTED_PROXIES)
2323
- `php artisan check:model-status` is now `php artisan ai:models:check-status`, to be more consistent with the naming of other AI related commands. The old command name is still available as an alias, but it is recommended to use the new command name.
2424

2525
### Bugfix

_changelog/2.5.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
### What's New
44

5-
- Added configuration settings for file uploads, that allow administrators to specify allowed file types and maximum file sizes, enhancing security and control over user uploads. See the [environment variables](../_documentation/3-architecture/10-dot%20Env.md#File-Upload-Settings) documentation for more details.
5+
- Added configuration settings for file uploads, that allow administrators to specify allowed file types and maximum file sizes, enhancing security and control over user uploads. See the [environment variables](../_documentation/200-Configuration/100-Dot-Env.md#File-Upload-Settings) documentation for more details.
66
- Improved accessiblity of the frontend by adding ARIA attributes and improving keyboard navigation, making it easier for users with disabilities to use the application. Thanks to [Thomas Orgeldinger](https://github.com/there-it-is) for the tremendous help!
7-
- Extended supported file formats for attachments: documents (PPTX, XLSX, HTML, Markdown, AsciiDoc, CSV, WebVTT) and additional image formats (SVG, TIFF, PSD, EPS, AI, BMP, ICO) are now handled via an image pre-processing pipeline using `rsvg-convert` and ImageMagick — auto-detected from `$PATH` when available. **Note:** PostScript-based formats (EPS, AI, PS) require `ghostscript` to be installed alongside ImageMagick. See the [optional dependencies](../_documentation/2-GettingStarted/1-Local%20Installation.md#optional-dependencies) documentation for installation instructions.
7+
- Extended supported file formats for attachments: documents (PPTX, XLSX, HTML, Markdown, AsciiDoc, CSV, WebVTT) and additional image formats (SVG, TIFF, PSD, EPS, AI, BMP, ICO) are now handled via an image pre-processing pipeline using `rsvg-convert` and ImageMagick — auto-detected from `$PATH` when available. **Note:** PostScript-based formats (EPS, AI, PS) require `ghostscript` to be installed alongside ImageMagick. See the [optional dependencies](../_documentation/100-GettingStarted/100-Local-Installation.md#optional-dependencies) documentation for installation instructions.
88
- Added support for the [Kreuzberg](https://github.com/kreuzberg-dev/kreuzberg) open-source document extraction API as a new file converter option. Configure via `KREUZBERG_FILE_CONVERTER_API_URL` in the `.env` file. No API key is required.
99
- All file access (attachments and avatars) is now securely proxied through the application via a dedicated storage proxy controller, with proper access control enforced for all file types and storage backends. Direct storage URLs are no longer exposed to clients.
1010
- Drag-and-drop file upload now provides real-time visual feedback: files are classified as valid or invalid against the server-configured allowed MIME types before the upload begins, and the file picker's `accept` attribute is automatically populated to match.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = {};

_documentation/200-Configuration/300-AI-Models-and-Tools.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,10 @@ This document describes HAWKI's AI model registry and tool system: how models an
1313
- [Database Registry](#database-registry)
1414
- [Model Sync](#model-sync)
1515
- [Model Online Status](#model-online-status)
16-
- [Value Object vs Eloquent Model](#value-object-vs-eloquent-model)
1716
4. [Tool System](#tool-system)
18-
- [Architecture: DB-First](#architecture-db-first)
19-
- [Tool Types](#tool-types)
20-
- [Tool Registry](#tool-registry)
21-
- [Function-Calling Tools](#function-calling-tools)
22-
- [MCP Tools](#mcp-tools)
23-
- [Tool Status vs Active State](#tool-status-vs-active-state)
2417
5. [Model–Tool Assignments](#modeltool-assignments)
2518
6. [Database Schema](#database-schema)
26-
7. [Service Providers](#service-providers)
27-
8. [Command Reference](#command-reference)
28-
9. [How-To Guides](#how-to-guides)
19+
7. [How-To Guides](#how-to-guides)
2920

3021
---
3122

_documentation/400-Contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ git push origin feature/your-feature-name --force-with-lease
7979

8080
HAWKI follows a lightweight Domain-Driven Design approach on top of Laravel 13 / PHP 8.3. The backend is in transition from server-rendered MVC to a pure API server for the Svelte frontend.
8181

82-
The full architecture documentation lives in the **[Backend section](./_documentation/Backend/)**:
82+
The full architecture documentation lives in the **[Backend section](500-Backend/index.md)**:
8383

8484
| I want to understand… | Read |
8585
|------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
@@ -167,7 +167,7 @@ There is currently no automated frontend test suite. Frontend testing will be in
167167

168168
## Frontend Code
169169

170-
> **Planned Svelte rewrite:** The HAWKI frontend is being progressively migrated to a Svelte 5 SPA. **Do not add new code to the legacy vanilla-JS layer** (`public/js/`). All new frontend work must follow the patterns in the [Frontend documentation](600-Frontend/).
170+
> **Planned Svelte rewrite:** The HAWKI frontend is being progressively migrated to a Svelte 5 SPA. **Do not add new code to the legacy vanilla-JS layer** (`public/js/`). All new frontend work must follow the patterns in the [Frontend documentation](600-Frontend/index.md).
171171
172172
| Topic | Document |
173173
|---------------------------------------------|-------------------------------------------------------------------|

_documentation/600-Frontend/400-Components/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ Snippets import from `components/`, not directly from `components/ui/`, unless t
237237

238238
## Accessing Server Data
239239

240-
Use `getConfig()` for runtime configuration values and the `getConnection()` family for auth-state-aware access. Both are available after the `preparation` boot stage. See [Data Layer](../300-Data) for the full reference.
240+
Use `getConfig()` for runtime configuration values and the `getConnection()` family for auth-state-aware access. Both are available after the `preparation` boot stage. See [Data Layer](../300-Data/index.md) for the full reference.
241241

242242
Use `__()` from `$lib/utils/translator.js` for all user-facing strings. See [Translations](../500-Utilities/100-Translations.md).
243243

0 commit comments

Comments
 (0)