hermes - 💡(How to fix) Fix [Bug]: Broken relative link in Docker docs to API server page [1 comments, 2 participants]

Bug Description

The Docker user guide links to a non-existent relative page for the API server docs.

In website/docs/user-guide/docker.md, the sentence:

Port 8642 exposes the gateway's OpenAI-compatible API server and health endpoint.

uses ./api-server.md, but that file does not exist in website/docs/user-guide/.

The actual page currently lives at:

• website/docs/user-guide/features/api-server.md

This causes a dead link in the rendered docs from a high-traffic setup page.

Steps to Reproduce

1. Open website/docs/user-guide/docker.md.
2. Locate the link target ./api-server.md in the “Running in gateway mode” section.
3. Verify file existence under website/docs/user-guide/.
4. Observe that api-server.md is missing there.
5. Check website/docs/user-guide/features/ and confirm api-server.md exists there.

Expected Behavior

The Docker docs should link to a valid API server documentation page so readers can navigate directly from Docker setup to API server usage details.

Actual Behavior

The current relative link points to a missing file (./api-server.md), resulting in a broken/dead docs link.

Affected Component

• Setup / Installation
• Other (documentation site content/navigation)

Messaging Platform (if gateway-related)

• N/A (CLI only)

Debug Report

N/A — docs-only static content issue; no runtime environment or logs required.

Operating System

N/A (docs content issue, reproducible by repository inspection)

Python Version

N/A

Hermes Version

N/A

Additional Logs / Traceback (optional)

None.

Root Cause Analysis (optional)

The link target appears stale after docs reorganization:

• Current broken reference: website/docs/user-guide/docker.md → ./api-server.md
• Existing target page: website/docs/user-guide/features/api-server.md

Likely fix options:

1. Update the link in docker.md to ./features/api-server.md (or site-absolute equivalent).
2. Optionally add docs-link checks in CI (if not already enforced for this path) to catch future regressions.

Proposed Fix (optional)

Patch website/docs/user-guide/docker.md line with:

• from: ./api-server.md
• to: ./features/api-server.md

Optional hardening: enforce dead-link validation for docs pages in CI if this path is currently skipped.

Are you willing to submit a PR for this?

Yes — happy to open a tiny docs PR if maintainers want.