Skip to content

Make Dokka API agent-friendly - #111

Merged
hdcodedev merged 1 commit into
mainfrom
fix/open-dokka-directly
Oct 17, 2026
Merged

hdcodedev merged 1 commit into
mainfrom
fix/open-dokka-directly

Conversation

@hdcodedev

Copy link
Copy Markdown
Member

Summary

Open API documentation as a full Dokka page. Replace the embedded iframe with a permanent redirect, and send /api/<version> aliases directly to the version's Dokka index.

Show API ↗ in desktop and mobile navigation and open it in a new tab. Add an accessible new-tab label and the same indicator to the metadata API link.

Validation

  • Passed bash scripts/test-docs-release-links-contract.sh.
  • Passed npm --prefix docs-app run build, including TypeScript checks.
  • Checked production HTTP responses for all 8 registered versions: the canonical API route and both alias forms redirect directly to the correct Dokka index. Alias query strings survive; unknown versions stay 404.
  • Confirmed the final API response contains readable Dokka package links and no iframe.
  • Browser checks passed for desktop and mobile docs and marketing navigation: clicking API ↗ opens a new tab with full Dokka and leaves the original page open.
  • Inspected desktop/mobile screenshots and the standalone Dokka page.
  • ESLint remains blocked by the repository's TypeScript 7 / typescript-eslint incompatibility. Dependency files are unchanged.

To verify from the repository root:

npm ci --prefix docs-app
npm run build
npm start -- --port 3137

Open / and /3.0.0/wiki at http://localhost:3137, then click API ↗. Dokka should open in a new tab. Repeat at a mobile viewport with the navigation menu open. Open /3.0.0/api and /api/3.0.0/ directly; both should lead to /static/api/3.0.0/index.html.

@vercel

vercel Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
charts.hdcode.dev Ready Ready Preview Oct 17, 2026 1:03am UTC

@hdcodedev hdcodedev changed the title fix: open Dokka API documentation in a new tab Make Dokka API agent-friendly Oct 17, 2026
@hdcodedev
hdcodedev merged commit 6953921 into main Oct 17, 2026
3 checks passed
@hdcodedev
hdcodedev deleted the fix/open-dokka-directly branch October 17, 2026 01:04

This branch was successfully deployed

1 active deployment
Preview — 726eb693 Deployed Oct 17, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant