skills.rest
JuantoC
JuantoCCOMMUNITY
Explore all skills by this author →
GitHub

generate-readme

Generate or refresh README.md files for BlueStack project folders.

Updated Aug 23, 2026
Search Tags:#template#documentation#readme#filesystem#wiki#generate
One-click install
npx skills add https://github.com/JuantoC/BlueStack-Test-Automation-Framework --skill generate-readme-juantoc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-readme
Source: https://github.com/JuantoC/BlueStack-Test-Automation-Framework/tree/main/.claude/skills/generate-readme
Command: npx skills add https://github.com/JuantoC/BlueStack-Test-Automation-Framework --skill generate-readme-juantoc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates or updates a README.md for a folder or module in the project, ensuring documentation reflects BlueStack conventions and structure to improve navigation and onboarding.

Core Features & Use Cases

  • Create README: generate a new README.md for a folder/module that lacks one, following the canonical template and metadata rules.
  • Update README: refresh an existing README.md to align with the current filesystem, tree structure, and conventions.
  • References & pointers: wire in pointers to wiki pages, related source files, and other project references without duplicating content.
  • Metadata hygiene: enforce frontmatter with name and description, maintain @last-reviewed timestamps, and guide usage to source pointers rather than embedding code.

Quick Start

Escribe un README completo para la carpeta objetivo, siguiendo la plantilla canónica y reflejando la estructura actual del proyecto.

Frequently Asked Questions about generate-readme

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

FAQPage Schema
How do I generate a README for a project folder that lacks one?▼

Generate a missing README by applying the canonical template and metadata rules to the target folder, reflecting the current filesystem structure. This ensures new module documentation aligns with repository conventions and improves project navigation.

What is the best way to update an existing README to match the current filesystem?▼

Update an existing README by refreshing its content to align with the current filesystem tree and project conventions. This process maintains the frontmatter metadata and ensures the documentation accurately reflects the latest module structure.

Can I embed TypeScript code directly into generated README files?▼

Embedding TypeScript code directly into README files is not supported. You must use pointers to source files or wiki pages instead of inlining code, ensuring documentation remains maintainable and avoids duplicating code snippets.

What metadata is required when generating a README for a module?▼

Required README metadata includes frontmatter with name and description fields, and a current last-reviewed timestamp. Maintaining this metadata hygiene ensures folder documentation remains compliant with repository standards.

How do I link generated READMEs to wiki pages and related references?▼

Link generated READMEs to wiki pages by wiring in pointers to related source files and project references. This avoids content duplication while directing users to comprehensive documentation and relevant code locations.

Does generating folder documentation require specific dependencies?▼

Generating folder documentation operates without external dependencies and requires no specific components. It focuses solely on applying repository conventions and structural templates to produce compliant README files.

Related Skills

Explore More Software Engineering Skills→
telum-aitelum-ai
2

project-import

Create a Speck project structure with a skeleton project.md file.

Official
Basic
TheWinciTheWinci
29

wiki

Generate a structured Markdown wiki with architecture maps and Mermaid diagrams from a codebase.

Community
Advanced
aifuunaifuun

test-version-207

yes

Community
Basic
ayehiaaayehiaa

zoom-out

Generate module and caller maps using project domain glossary vocabulary.

Community
Basic