Skip to content

Commit b897c2f

Browse files
Copilotmrjf
andauthored
docs: warn that wiki must be initialized before running agentic-wiki-writer (#265)
* Initial plan * docs: add warning that wiki must be initialized before running agentic-wiki-writer Co-authored-by: mrjf <180956+mrjf@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: mrjf <180956+mrjf@users.noreply.github.com>
1 parent c782200 commit b897c2f

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

docs/agentic-wiki-writer.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
The [Agentic Wiki Writer workflow](../workflows/agentic-wiki-writer.md?plain=1) keeps your project's GitHub wiki synchronized with the codebase. After each merged pull request (or on demand), it reads a `PAGES.md` template to understand what to document, then writes wiki pages directly from the source code.
88

9+
> [!WARNING]
10+
> **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.
11+
912
## Installation
1013

1114
```bash

0 commit comments

Comments
 (0)