Skip to content

docs: add wiki enable step to agentic-wiki-writer and agentic-wiki-coder #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrjf merged 3 commits into from
Mar 17, 2026
Merged

docs: add wiki enable step to agentic-wiki-writer and agentic-wiki-coder #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5454a98
Initial plan
Copilot Mar 15, 2026
5c450ea
doc: add wiki enable instructions to agentic-wiki-writer and agentic-…
Copilot Mar 15, 2026
adbc20e
Merge branch 'main' into copilot/update-wiki-documentation
mrjf Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/agentic-wiki-coder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 3 additions & 1 deletion docs/agentic-wiki-writer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading