rewrite-docs

Rewrite JSDoc blocks in the background-geolocation-types TypeScript API.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/transistorsoft/docforge --skill rewrite-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rewrite-docs
Source: https://github.com/transistorsoft/docforge/tree/main/skills/rewrite-docs
Command: npx skills add https://github.com/transistorsoft/docforge --skill rewrite-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Rewrites and standardizes JSDoc blocks in the background-geolocation-types TypeScript API to ensure consistent structure, headings, and examples across all target platforms.

Core Features & Use Cases

  • Standardizes prose, sectioning, and example placement to align with the four generators (TypeDoc, Dartdoc, Dokka, DocC).
  • Enforces platform-aware labeling and cross-checks against native code for defaults and behavior.
  • Improves maintainability by providing a single, reusable rewrite workflow that reduces drift between TS API docs and native SDK docs.

Quick Start

Follow the guidelines to rewrite all JSDoc blocks in the TypeScript API before touching any doc blocks.

Frequently Asked Questions about rewrite-docs

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

FAQPage Schema
How do I standardize JSDoc blocks for cross-platform TypeScript APIs?

Standardizing JSDoc blocks for cross-platform TypeScript APIs involves rewriting documentation with platform-neutral prose and specific sections for iOS and Android. This enforces consistent headings, explicit defaults, and unified examples across target generators like TypeDoc and Dartdoc.

What is the best way to maintain consistent documentation across TypeDoc, Dartdoc, Dokka, and DocC?

Maintaining consistent documentation across TypeDoc, Dartdoc, Dokka, and DocC requires standardizing prose, sectioning, and example placement through a single reusable rewrite workflow. This approach reduces drift between TypeScript API docs and native SDK documentation.

Why does my TypeScript API documentation drift from native iOS and Android SDK docs?

TypeScript API documentation drifts from native iOS and Android SDK docs when JSDoc blocks lack structured templates and platform-aware labeling. Cross-checking against native sources during the rewrite process ensures defaults and behavior remain accurate and complete.

Does rewriting JSDoc support platform-specific sections for iOS and Android?

Yes, rewriting JSDoc supports platform-specific sections for iOS and Android. The process uses platform-neutral prose for general descriptions while enforcing explicit default values and distinct sections tailored to each operating system's native behavior.

When do I need to use a structured JSDoc template for documentation generation?

You need a structured JSDoc template for documentation generation when targeting multiple platforms like iOS and Android. It enforces consistent headings, explicit default values, and cross-checked accuracy across all target documentation generators.