area-manifest-authoring

Create or refresh documentation audit manifests by analyzing watched repositories and validating via the prepare step.

9|11|Updated May 7, 2025
One-click install
npx skills add https://github.com/lancedb/docs --skill area-manifest-authoring
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: area-manifest-authoring
Source: https://github.com/lancedb/docs/tree/main/workflows/docs-audit/skills/area-manifest-authoring
Command: npx skills add https://github.com/lancedb/docs --skill area-manifest-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps teams efficiently create and maintain accurate manifests for docs audit areas, enabling better tracking of relevant evidence and ensuring documentation remains up-to-date.

Core Features & Use Cases

  • Manifest Generation: Automates the creation and refresh of manifests/<area>.toml files.
  • Source Discovery: Finds relevant source files like snippets, tests, and schemas strategically aligned with user-visible signals.
  • Use Case: For a new docs domain, quickly generate a manifest that maps pages to the most relevant public evidence, reducing manual effort and errors.

Quick Start

Use the area-manifest-authoring skill to generate or update documentation manifests for a specific area by scanning the relevant repositories and validating the output locally.

Frequently Asked Questions about area-manifest-authoring

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

FAQPage Schema
How do I automate documentation audit manifest creation for my repositories?

You can automate documentation audit manifest creation by scanning watched repositories for user-facing evidence like snippets and schemas. This generates a compact source list mapping pages to relevant evidence, reducing manual effort and errors.

What is a docs audit manifest and when do I need to refresh it?

A docs audit manifest is a TOML file mapping documentation pages to relevant source evidence like snippets, tests, and schemas. You need to refresh it when source files change or new user-visible signals are added to keep tracking accurate.

How do I generate a manifest that maps docs pages to source evidence?

Generating a manifest that maps docs pages to source evidence requires scanning repositories for strategically aligned snippets, tests, and schemas. The process validates the output by running the prepare step locally to ensure the manifest is accurate.

Can I use this manifest authoring process for a new docs domain?

Yes, you can use this manifest authoring process for a new docs domain to quickly generate a mapping of pages to public evidence. It scans watched repositories and validates the output locally through a prepare step.

What source files are included when building a docs audit manifest?

Building a docs audit manifest includes discovering source files like snippets, tests, and schemas strategically aligned with user-visible signals. This maintains a compact source list to ensure accurate and up-to-date documentation tracking.