Skip to content

Configuration Solutions

Lewis Ginn edited this page Jun 9, 2026 · 1 revision

Configuration — Solutions

The solutions section tells PowerAutoDocs where your unpacked solution files are and how to identify custom components within them.

Unpacking solutions first

PowerAutoDocs reads from unpacked solution files — the XML and JSON produced when you unpack a solution ZIP using the Power Platform CLI. If you haven't unpacked your solution yet, see Running Locally for the command.

The unpacked folder should be committed to your repo. PowerAutoDocs reads from it at documentation time.

Basic setup — single solution

solutions:
  - path: ./unpacked/MySolution
    publisherPrefix: cr123
    displayName: My Solution
Field Required Description
path Yes Path to the unpacked solution folder, relative to the repo root
publisherPrefix Yes The customisation prefix for your publisher — used to identify custom components
displayName No Friendly name shown in the documentation. Defaults to the solution's internal name if omitted.

Finding your publisher prefix

The publisher prefix is the short prefix on all your custom components (e.g. cr123_MyTable). To find it:

  1. Open the Power Platform maker portal
  2. Select the correct environment
  3. Go to Settings (gear icon, top right) → Advanced settings
  4. Go to CustomisationsPublishers
  5. Find your publisher — the prefix is listed in the Prefix column

Multi-solution projects

If your project spans more than one solution, list all of them. PowerAutoDocs reads each one independently and merges the results into a single set of documentation.

solutions:
  - path: ./unpacked/CoreSolution
    publisherPrefix: cr123
    displayName: Core

  - path: ./unpacked/PluginsSolution
    publisherPrefix: cr123
    displayName: Plugins

  - path: ./unpacked/FlowsSolution
    publisherPrefix: cr123
    displayName: Flows

All solutions under the same publisher prefix will share the same component namespace — entities, flows, and other components are de-duplicated and cross-referenced automatically.

Path resolution

Paths are resolved relative to the directory containing doc-gen.config.yml — normally the repo root. You can use any relative path:

solutions:
  - path: ./unpacked/MySolution      # subfolder of repo root
  - path: ../shared/AnotherSolution  # outside repo root (less common)

Clone this wiki locally