capability-manifest

Extract and verify SDK symbols and contracts using griffe and Python scripting.

26|16|Updated May 23, 2024

Search Tags:#code analysis #documentation #api #verification #sdk #symbol extraction

Ready to run

npx skills add https://github.com/atlanhq/application-sdk --skill capability-manifest

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: capability-manifest
Source: https://github.com/atlanhq/application-sdk/tree/main/.claude/skills/capability-manifest
Command: npx skills add https://github.com/atlanhq/application-sdk --skill capability-manifest

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines the process of creating and maintaining an up-to-date, comprehensive capability manifest for software development kits.

Core Features & Use Cases

Create or audit SDK capability documentation by extracting symbols, signatures, and docstrings from code.
Support SDK development workflows such as verifying manifest freshness and identifying drift between source code and documentation.
Use Case: When starting a new agent or updating SDK content, automatically generate or verify the capability inventory to ensure accurate project documentation.

Quick Start

Run the capability-manifest skill to create or refresh the SDK's capability manifest for quick documentation updates.

Frequently Asked Questions about capability-manifest

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

FAQPage Schema

How do I extract SDK symbols and signatures for API documentation?▼

Automate SDK capability documentation by extracting symbols, signatures, and docstrings directly from source code using griffe and Python scripting. This capability verification ensures your API manifest accurately reflects the current codebase structure.

What is a capability manifest and when do I need to generate one?▼

A capability manifest is an inventory of SDK symbols, contracts, and signatures. You need to generate one during SDK onboarding, auditing, or documentation updates to ensure API references accurately reflect the codebase.

How do I verify SDK documentation freshness and identify drift from source code?▼

Verify SDK documentation freshness and identify source code drift by running automated extraction and verification scripts. This compares the capability manifest against current signatures and docstrings to highlight discrepancies.

Do I need Python and griffe to parse code structures for capability auditing?▼

Yes, you need Python and griffe to parse code structures for capability auditing. The Skill requires griffe to analyze signatures, extract symbols, and verify SDK contracts during the documentation generation process.

Can I automate API documentation health checks for an existing SDK?▼

Yes, you can automate API documentation health checks for an existing SDK. The Skill audits the capability inventory by extracting and verifying symbols to identify documentation drift and ensure continuous accuracy.