skills.rest
AvaloniaUI
AvaloniaUIOFFICIAL
Explore all skills by this author →
Website𝕏@AvaloniaUIGitHub

api-link-builder

Map unlinked type references to API entries using the xref index.

157|301|Updated Apr 24, 2023
Search Tags:#automation#documentation#api#integration#cross-linking#docs-api#xref-index
One-click install
npx skills add https://github.com/AvaloniaUI/avalonia-docs --skill api-link-builder
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-link-builder
Source: https://github.com/AvaloniaUI/avalonia-docs/tree/main/.claude/skills/api-link-builder
Command: npx skills add https://github.com/AvaloniaUI/avalonia-docs --skill api-link-builder

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scans documentation in /docs and API reference pages in /api to automatically identify unlinked references and create precise, bidirectional cross-links, improving discoverability and reducing navigation friction.

Core Features & Use Cases

  • Detects unlinked type mentions in docs and API pages and maps them to the corresponding API entries using a local xref index.
  • Migrates external API links to local /api paths to ensure consistent navigation.
  • Works across entire docs trees or scoped subsets (by path, topic, or namespace) to surface the most relevant cross-links.

Quick Start

Run the skill to scan docs/ and api/ for bidirectional cross-links and apply the recommended edits.

Frequently Asked Questions about api-link-builder

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically cross-link API references in documentation?▼

To automatically cross-link API references in documentation, scan your docs and API pages to detect unlinked type mentions and map them to corresponding API entries using a local xref index, producing bidirectional links between both.

What is the best way to find unlinked type references in docs and API pages?▼

Finding unlinked type references is best handled by scanning the docs and controls directories for type mentions and mapping them to API entries via the xref index at .apiref/generated/xref-index.json, generating doc-to-api and api-to-doc opportunities.

Can I scope API documentation cross-linking to a specific directory or namespace?▼

Yes, you can scope API documentation cross-linking by providing a directory path, file path, topic, or namespace as input. Without arguments, the scan defaults to searching across the entire docs directory.

How does bidirectional doc-API linking handle external API links?▼

Bidirectional doc-API linking migrates external API links to local /api paths to ensure consistent navigation. It also preserves the apiref-page__docs-links block on API pages when applying cross-link edits.

Do I need a generated xref index to map documentation to API entries?▼

Yes, you need a generated xref index located at .apiref/generated/xref-index.json to map documentation references. The skill depends on this local index to accurately identify and link unlinked type mentions to their corresponding API entries.

Related Skills

Explore More Content & Communication Skills→
matteingmatteing
56

elixir-cyclic-deps

Detect and remove compile-time dependency cycles in Elixir projects using mix xref.

Community
Intermediate
Delphine-LDelphine-L
17

obsidian

Create session notes and tasks in an Obsidian vault with bidirectional links.

Community
Intermediate
jason-c-devjason-c-dev
1

documentation-standards

Enforce documentation standards for AWS Coworker components with Markdown conventions.

Community
Advanced
TheMattBermanTheMattBerman
92

seo-links

Mine competitor backlinks, unlinked mentions, and broken link opportunities.

Community
Intermediate