Skip to content

Commit c7e1542

Browse files
Copilotmrjfdsyme
authored
Fix agentic-wiki-writer: fix backslash pipe escaping in wiki links (#282)
* Initial plan * Fix agentic-wiki-writer: single push-wiki call and bare pipe in wiki links Co-authored-by: mrjf <180956+mrjf@users.noreply.github.com> * Keep batched push-wiki from PR #279, add max:5 config, fix backslash pipe Co-authored-by: mrjf <180956+mrjf@users.noreply.github.com> * Increase push-wiki max from 5 to 10 Co-authored-by: mrjf <180956+mrjf@users.noreply.github.com> * Fix CI: remove invalid max property from custom push-wiki job 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> Co-authored-by: Russell Horton <mrjf@github.com> Co-authored-by: Don Syme <dsyme@users.noreply.github.com>
1 parent 851905c commit c7e1542

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

workflows/agentic-wiki-writer.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,6 +578,8 @@ Determine the correct `OWNER/REPO` and default branch by reading `.git/config` w
578578

579579
**Wiki cross-references** — Use wiki link syntax: `[[Page Name]]` or `[[Display Text|Page-Slug#section-slug]]`.
580580

581+
The `|` separator between display text and slug must be a bare pipe — do NOT backslash-escape it (`[[Control Plane\|Control-Plane]]` is wrong; `[[Control Plane|Control-Plane]]` is correct).
582+
581583
Only link to pages and sections that exist in the PAGES.md template. Use plain text for anything else.
582584

583585
NEVER use `[[display|https://...]]` — that is NOT valid wiki syntax. Use `[display](https://...)` for external URLs.
@@ -600,7 +602,7 @@ Before finalizing each page, check for these issues and fix them:
600602

601603
3. **Heading levels** — No page should start with `#` (H1). Start with content or `##` (H2).
602604

603-
4. **Link format** — Source code links use full GitHub URLs `[text](https://...)`. Wiki cross-references use `[[Page Name]]`. No bare relative paths. No `[[text|https://...]]` syntax.
605+
4. **Link format** — Source code links use full GitHub URLs `[text](https://...)`. Wiki cross-references use `[[Page Name]]` or `[[Display Text|Page-Slug]]` with a bare `|` (never backslash-escaped). No bare relative paths. No `[[text|https://...]]` syntax.
604606

605607
5. **Accuracy** — Content matches what the source code actually does. No fabricated features or APIs.
606608

0 commit comments

Comments
 (0)