Skip to content

Configure platform contexts for ApiLink index resolution#256

Open
viktorkombov wants to merge 1 commit into
masterfrom
vkombov/configure-apilink-index-resolution
Open

Configure platform contexts for ApiLink index resolution#256
viktorkombov wants to merge 1 commit into
masterfrom
vkombov/configure-apilink-index-resolution

Conversation

@viktorkombov
Copy link
Copy Markdown
Contributor

Summary

Adds ApiLink index configuration to platform contexts so docs can resolve API links through the generated api-docs registry.

This keeps MDX usage simple and avoids repeating pkg, kind, prefix, and suffix details in content files.

Changes

  • Added apiLinkIndexRoot to platform contexts.
  • Added API docs base URL handling for staging, production, and local api-docs testing.
  • Keeps local testing configurable through API_DOCS_BASE_URL.
  • Preserves existing ApiLink fallback behavior when the index is unavailable.

Testing

Run api-docs locally:
npm run start:angular:en -- --port 4322

Run docs-template against it:
$env:API_DOCS_BASE_URL="http://localhost:4322/api"
npm run angular:dev

Verify Angular dashboard tile API links:

  • CategoryChart resolves to igniteui-angular-charts
  • DataChart resolves to igniteui-angular-charts
  • GeographicMap resolves to igniteui-angular-maps
  • member links resolve with anchors
  • excluded links still render as code on excluded platforms

@viktorkombov viktorkombov added the ❌ status: awaiting-test PRs awaiting manual verification label May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

❌ status: awaiting-test PRs awaiting manual verification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant