documentation

Map changed bunli implementation files to expected documentation paths via git diff.

95|5|Updated Jun 16, 2025

Search Tags:#developer workflow #monorepo #api docs #git diff #stale documentation #documentation freshness

Ready to run

npx skills add https://github.com/AryaLabsHQ/bunli --skill documentation-aryalabshq

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/AryaLabsHQ/bunli/tree/main/.agents/skills/documentation
Command: npx skills add https://github.com/AryaLabsHQ/bunli --skill documentation-aryalabshq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you quickly identify when recent implementation changes in the bunli monorepo likely require updating API documentation, so users aren’t left with stale or misleading docs.

Core Features & Use Cases

Changed-file detection: Finds recently modified implementation files via git diff.
Doc mapping & comparison: Matches changed packages/*/src/ files to specific documentation targets and checks whether the API surface likely changed.
Actionable output: Reports which docs are likely stale and whether a full documentation audit is warranted, without doing a full sweep.

Quick Start

Run this Skill right after updating code in packages/*/src/ to get a concise list of documentation pages that may need refresh.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I detect stale documentation after code changes in a monorepo?▼

To detect stale documentation in a monorepo, run git diff to list changed implementation files and map them to expected docs paths. This identifies which documentation pages may need updates after recent code changes.

What is documentation drift and how do I identify it?▼

Documentation drift occurs when implementation changes outpace documented API surfaces. Identify it by comparing modified files from git diff against existing docs to see if core APIs, types, configs, or plugins have changed without corresponding documentation updates.

How do I check which API docs need updating after modifying packages source files?▼

Check which API docs need updating by matching changed packages/*/src/ files to specific documentation targets. The Skill compares implementation versus documented API signals and reports which doc pages are likely stale.

Does this documentation freshness check work for all files in the monorepo?▼

This documentation freshness check applies to core APIs, types, configs, plugins, and package-level docs within the monorepo where API surface drift is possible. It focuses on implementation files under packages/*/src/ rather than every file.

When should I run a documentation audit after code changes?▼

Run a documentation audit when this Skill reports that multiple API surfaces have drifted after code changes. The Skill produces a concise recommendation on whether a full audit is warranted based on detected implementation versus documentation mismatches.

Can I automate documentation freshness checks in my developer workflow?▼

You can automate documentation freshness checks by running this Skill right after updating code in packages/*/src/ within your developer workflow. It uses git diff output to produce a concise list of documentation pages that may need refresh without a full sweep.