README Specialist

A GitHub Copilot chat plugin for creating and maintaining clear, practical README documentation while preserving a project's existing tone and style.

imageInstall Chat Plugin on VS Code imageInstall Chat Plugin on VS Code Insiders

Capabilities

• Creates and restructures README files using established documentation practices.
• Adds practical installation, usage, contributing, and license sections when applicable.
• Writes examples that are easy to follow.
• Keeps documentation consistent with the project's voice and conventions.
• Restricts changes to README and other documentation files.

Installation

Select the badge for your VS Code edition, then confirm the installation prompt in the editor.

Usage

1. Open a project in VS Code.
2. Open GitHub Copilot Chat and select the readme-specialist agent.
3. Describe the documentation change you need.

Example requests:

Create a README for this project with installation and usage instructions.

Update the README to document the new configuration options.

Review the README for missing setup steps and outdated examples.

Repository Structure

.
├── agents/
│   └── readme-specialist.agent.md
├── plugin.json
└── README.md

• plugin.json defines the plugin metadata.
• agents/ contains the portable agent definition.
• com.github.copilot/agents/ contains the GitHub Copilot agent definition. (symlink to agents/)
• .plugin/plugin.json contains plugin-specific configuration and data. (symlink to plugin.json)
• README.md is the main documentation file for the project.