diff --git a/docs/agentic-wiki-coder.md b/docs/agentic-wiki-coder.md index c40553e..c6e416b 100644 --- a/docs/agentic-wiki-coder.md +++ b/docs/agentic-wiki-coder.md @@ -55,7 +55,12 @@ It does **not** open a PR for typo fixes, formatting changes, or clarifications ### Setup -This workflow requires your repository to have a wiki enabled. It pairs naturally with [Agentic Wiki Writer](agentic-wiki-writer.md) to create a full bidirectional documentation loop. +This workflow requires your repository to have a wiki enabled and initialized: + +1. **Enable the wiki**: Go to your repository's **Settings** → **Features** and check the **Wikis** checkbox. +2. **Initialize the wiki**: Go to the **Wiki** tab and create a blank page (e.g. "Home"). GitHub does not create the underlying wiki git repository until at least one page exists. + +It pairs naturally with [Agentic Wiki Writer](agentic-wiki-writer.md) to create a full bidirectional documentation loop. After editing the workflow file, run `gh aw compile` to update the compiled workflow and commit all changes to the default branch. diff --git a/docs/agentic-wiki-writer.md b/docs/agentic-wiki-writer.md index d8ed4bc..239ebca 100644 --- a/docs/agentic-wiki-writer.md +++ b/docs/agentic-wiki-writer.md @@ -7,7 +7,9 @@ The [Agentic Wiki Writer workflow](../workflows/agentic-wiki-writer.md?plain=1) keeps your project's GitHub wiki synchronized with the codebase. Once a day (if any pull requests were merged to the default branch), it reads a `PAGES.md` template to understand what to document, then writes wiki pages directly from the source code. You can also trigger it manually on demand. > [!WARNING] -> **The repository wiki must be initialized before running this workflow.** GitHub does not create the wiki git repository until at least one page exists. Go to your repository's **Wiki** tab and create a blank page (e.g. "Home") to initialize it. The workflow will fail with a git clone error if this step is skipped. +> **The repository wiki must be enabled and initialized before running this workflow.** +> 1. **Enable the wiki**: Go to your repository's **Settings** → **Features** and check the **Wikis** checkbox. +> 2. **Initialize the wiki**: Go to the **Wiki** tab and create a blank page (e.g. "Home"). GitHub does not create the underlying wiki git repository until at least one page exists. The workflow will fail with a git clone error if this step is skipped. ## Installation