skills.rest
ax-llm
ax-llmOFFICIAL
Explore all skills by this author →
GitHub

website-md-language-docs

Synchronize Ax website language documentation with repository truth.

2.9k|186|Updated Feb 23, 2023
Search Tags:#documentation#markdown#examples#hugo#api-mapping#generated-content
One-click install
npx skills add https://github.com/ax-llm/ax --skill website-md-language-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: website-md-language-docs
Source: https://github.com/ax-llm/ax/tree/main/tools/website-md/skills/website-md-language-docs
Command: npx skills add https://github.com/ax-llm/ax --skill website-md-language-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps Ax website language documentation accurate when public APIs, examples, package metadata, or supported language routes change, so the markdown site does not drift from repository truth.

Core Features & Use Cases

  • Syncs common prose in templates and language-specific details in per-language JSON manifests.
  • Maps API sections for TypeScript and generated language packages to the right docs pages.
  • Supports adding or reordering website language routes through a single site map.
  • Helps maintain runnable public examples, generated package docs, and verified markdown outputs without hand-editing generated files.
  • Example: use it when a new language feature needs updated snippets, package labels, and route navigation across the website.

Quick Start

Update the relevant Ax website language route by syncing the repo truth into the language manifest, examples, and site map before regenerating the markdown output.

Frequently Asked Questions about website-md-language-docs

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

FAQPage Schema
How do I keep website language documentation synced with repository truth?▼

To keep website language documentation synced, you must align markdown routes, API symbol mappings, and example catalogs with repository truth using curated templates and per-language manifests before regenerating outputs. This prevents documentation drift during website updates.

How do I map API sections for generated language packages to the correct docs pages?▼

Mapping API sections for generated language packages requires applying per-language JSON manifests that connect TypeScript and generated package API symbols to their corresponding markdown documentation pages. This ensures API mappings remain accurate across website updates.

What's the best way to add or reorder website language routes without manual edits?▼

The best way to add or reorder website language routes is through a single site map configuration. This approach syncs route navigation across the website without requiring hand-edits to individual generated markdown files.

Why does documentation drift occur between markdown sites and repository code?▼

Documentation drift occurs when public APIs, examples, or package metadata change in the repository but the markdown site is not updated. Verifying generated outputs against repository truth prevents this drift from accumulating during website updates.

Can I use Hugo to maintain generated package documentation from a single source?▼

Yes, you can use Hugo to maintain generated package documentation by syncing repository truth into language manifests and site maps before regeneration. This workflow supports runnable public examples and verified markdown outputs without hand-editing generated files.

When do I need to update per-language manifests for documentation?▼

You need to update per-language manifests when a new language feature requires updated snippets, package labels, or route navigation. Syncing these manifests with repository truth ensures the markdown site reflects current API symbol mappings and example catalogs.

Related Skills

Explore More Software Engineering Skills→
8Dionysus8Dionysus
4

aoa-source-of-truth-check

Identify and resolve documentation ambiguity to establish a single source of truth.

Community
Intermediate
therealbilltherealbill
3

Hugo S3 Deployment

Deploy Hugo static sites to S3 and CloudFront with OIDC-enabled GitHub Actions.

Community
Advanced
zircotezircote
3

documentation-standards

Audit Markdown documentation structure, formatting, links, and accessibility against defined standards.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate