write-about

Generate about.md documentation for Orchid ORM features from code analysis.

543|15|Updated Jul 8, 2022
One-click install
npx skills add https://github.com/romeerez/orchid-orm --skill write-about
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-about
Source: https://github.com/romeerez/orchid-orm/tree/main/.agents/skills/write-about
Command: npx skills add https://github.com/romeerez/orchid-orm --skill write-about

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation of documentation for specific Orchid ORM features, streamlining the process and reducing manual effort.

Core Features & Use Cases

  • Feature Documentation: Automatically generate about.md files for Orchid ORM features based on code analysis and user input.
  • User Interaction: Interacts with users to gather necessary details about the feature and confirm the document's location.
  • Use Case: For a new feature, the user prompts the skill with the feature's name or a description. The skill then writes and saves a about.md file with detailed information about the feature.

Quick Start

Run the write-about skill with the feature name as an argument: write-about feature-name.

Frequently Asked Questions about write-about

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

FAQPage Schema
How do I automate documentation generation for Orchid ORM features?

To automate documentation generation for Orchid ORM features, you run a script that analyzes your TypeScript code and prompts you for details, producing an about.md file. This skill writes the feature documentation automatically based on your input and code analysis.

What is the process for creating feature documentation in TypeScript-based ORMs?

Creating feature documentation in TypeScript-based ORMs involves running a Python script to analyze code and gather user input, resulting in a detailed about.md file. This skill automates that process by prompting you for feature details and generating the document based on code analysis.

Do I need Python to generate Orchid ORM documentation with this tool?

Yes, Python is required to generate Orchid ORM documentation because the skill relies on Python scripting for code analysis and user interaction. You must have Python installed to run the script that analyzes your TypeScript code and produces the about.md file.

Can I use this tool to write usage docs for any TypeScript ORM?

This tool is designed for Orchid ORM but is applicable to feature description and usage documentation creation in TypeScript-based ORMs generally. It analyzes your code and generates an about.md file tailored to the specific feature you describe.

What's the best way to write an about.md file for a new Orchid ORM feature?

The best way to write an about.md file for a new Orchid ORM feature is to run the write-about skill with the feature name as an argument. It analyzes the code, prompts you for confirmation, and automatically saves the generated about.md file in the specified location.