doc gen.config.yml

doc-gen.config.yml

doc-gen.config.yml is the main configuration file for PowerAutoDocs. It tells the tool which solutions to document, what output formats to generate, and how to connect to your ADO Wiki.

Where it lives

The file must be named doc-gen.config.yml and placed in your repo root. This is the folder you run npx powerautodocs@latest from, or the root of the repo that your ADO pipeline checks out.

If you need to keep it somewhere else, set the DOC_GEN_CONFIG_DIR environment variable to the directory containing it:

# Locally
export DOC_GEN_CONFIG_DIR=/path/to/config/folder

# In ADO pipeline variables
DOC_GEN_CONFIG_DIR = $(Build.SourcesDirectory)/config

Getting started

Copy the sample file from the repo and rename it:

[samples/doc-gen.config.sample.yml](https://github.com/lewginn/PowerAutoDocs/blob/main/samples/doc-gen.config.sample.yml)  →  doc-gen.config.yml (repo root)

The sample file contains every available field with comments explaining what each one does. This page gives you the overview — the detailed pages below cover each section in full.

Structure

The config file is divided into sections:

Section	What it controls
solutions	Which unpacked solution folders to read from
output	Which formats to generate (wiki, Word, PDF) and where to write files
wiki	How to connect to your ADO Wiki
components	Which component types to include in the output
aiEnrichment	Optional AI-generated summaries

Minimal example

This is the smallest valid config — one solution, wiki and Word output enabled:

solutions:
  - path: ./unpacked/MySolution
    publisherPrefix: cr123
    displayName: My Solution

output:
  path: ./output
  wiki: true
  word: true
  wordFilename: solution-documentation.docx

wiki:
  organisation: MyOrg
  project: MyProject
  wikiIdentifier: MyProject.wiki
  parentPath: /My Solution
  pat: REDACTED

pat: REDACTED is intentional — never put a real PAT in this file. The actual token is supplied at runtime via an environment variable or pipeline secret. See Wiki Connection for how this works.

Sections in detail

• Solutions
• Output Formats
• Wiki Connection
• Component Toggles
• AI Enrichment