user-docs-detect-shape

Analyze repository file structures to determine project type and technical metadata.

Updated Mar 24, 2026
One-click install
npx skills add https://github.com/spencerbeggs/design-docs-plugin --skill user-docs-detect-shape
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: user-docs-detect-shape
Source: https://github.com/spencerbeggs/design-docs-plugin/tree/main/plugin/skills/user-docs-detect-shape
Command: npx skills add https://github.com/spencerbeggs/design-docs-plugin --skill user-docs-detect-shape

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates the ambiguity of project architecture by automatically detecting whether a repository is a single package, a monorepo root, or a sub-package, ensuring documentation tools operate on the correct scope.

Core Features & Use Cases

  • Automated Repo Profiling: Identifies package managers, runtime environments (Node, Bun, Deno), and TypeScript versions.
  • Contextual Awareness: Distinguishes between monorepo roots and individual packages to prevent documentation generation errors.
  • Use Case: When preparing to generate user-facing documentation for a large project, use this skill to verify the project structure and runtime requirements so the documentation agent can apply the correct templates and badges.

Quick Start

Ask the assistant to detect the shape and metadata of the current repository to initialize the documentation environment.

Frequently Asked Questions about user-docs-detect-shape

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

FAQPage Schema
How do I detect repository structure and metadata for documentation generation?

To detect repository structure and metadata, you can analyze file structures and configuration files to determine project type, runtime environment, and license information. This operates across single-package and monorepo environments using read-only file system probing.

How does automated monorepo detection distinguish between root and sub-packages?

Monorepo detection distinguishes root from sub-packages by probing repository file structures and configuration files. This contextual awareness prevents documentation generation errors by ensuring tools operate on the correct project scope and apply accurate metadata.

Can I identify runtime environments and package managers in a monorepo?

Yes, you can identify runtime environments like Node, Bun, or Deno and extract package manager details by analyzing repository configuration files. This automated profiling provides accurate technical metadata for documentation workflows.

Does read-only file system probing modify my repository configuration files?

Read-only file system probing does not modify your repository configuration files. It safely analyzes project metadata, dependencies, and TypeScript versions without altering the underlying file structure or writing new data.

What is the best way to prepare a large project for user-facing documentation generation?

The best way to prepare for documentation generation is to verify project structure and runtime requirements first. Detecting package managers and monorepo architecture ensures the documentation agent applies correct templates and badges.