PowerPlatform-DataversePluginsDoc

GitHub Copilot Instructions for Dataverse Plugin Documentation

These instructions guide the agent in documenting Dataverse .NET plugins developed in the codebase.

---

📌 Documentation Context

• This documentation is for Dataverse C# Plugin projects
• Each plugin project is located under Plugins/{ProjectName}/
• Projects contain:
  • Helpers/ - Reusable helper classes
  • Plugins/ - Plugin implementations (standard messages or custom APIs)
  • {ProjectName}.csproj - Project file with NuGet configuration

---

📁 Documentation Structure

Each plugin project should have three markdown documentation files in its root folder:

Plugins/
└── {ProjectName}/
    ├── README.md                 # Global project documentation with table of contents
    ├── HELPERS.md                # Helper classes documentation
    ├── PLUGINS.md                # Plugin implementations documentation
    ├── Helpers/                  # Helper source code
    ├── Plugins/                  # Plugin source code
    └── {ProjectName}.csproj      # Project file

---

📝 Documentation Files Structure

1. README.md - Global Project Documentation

This is the main entry point for the plugin project documentation.

Structure:

# {Project Name} - Dataverse Plugin Package

## Overview
Brief description of the project purpose and scope.

## Package Information

| Property | Value |
|----------|-------|
| **Package ID** | {PackageId from .csproj} |
| **Version** | {Version from .csproj} |
| **Authors** | {Authors from .csproj} |
| **Company** | {Company from .csproj} |
| **Target Framework** | net462 |
| **Assembly Signing** | Yes (.snk) |

## Dependencies

### NuGet Packages
- `Microsoft.CrmSdk.CoreAssemblies` - Version X.X.X
- `Microsoft.PowerApps.MSBuild.Plugin` - Version X.X.X
- `Microsoft.NETFramework.ReferenceAssemblies` - Version X.X.X

### Dependent Assemblies
List any additional assemblies included in the package (if applicable).

## Documentation

### [Helper Classes](HELPERS.md)
- [HelperName1](HELPERS.md#helpername1)
- [HelperName2](HELPERS.md#helpername2)
- ...

### [Plugin Implementations](PLUGINS.md)
- [PluginName1](PLUGINS.md#pluginname1)
- [PluginName2](PLUGINS.md#pluginname2)
- ...

## Deployment

This package is deployed using Power Platform CLI:
\`\`\`sh
pac plugin push --pluginId {PluginPackageId} --pluginFile ./bin/Release/{ProjectName}.{Version}.nupkg
\`\`\`

**Note:** The plugin package ID is provided by the user after initial import into the environment.

## Environment Variables

List of required environment variables (if applicable):
- `env_VariableName1` - Description
- `env_VariableName2` - Description

## Prerequisites

- Dataverse environment with required tables
- Security roles configured
- Environment variables configured