Skip to content

docs: document PAGES.md template format for agentic-wiki-writer#262

Merged
mrjf merged 2 commits intomainfrom
copilot/document-wiki-writer-pages-template
Mar 13, 2026
Merged

docs: document PAGES.md template format for agentic-wiki-writer#262
mrjf merged 2 commits intomainfrom
copilot/document-wiki-writer-pages-template

Conversation

Copy link
Contributor

Copilot AI commented Mar 13, 2026

docs/agentic-wiki-writer.md had no documentation on the PAGES.md file that drives wiki structure — how it's generated, what the format is, or how to customize it.

Changes

  • New PAGES.md Format section in docs/agentic-wiki-writer.md covering:
    • Lifecycle: auto-generated on first run as a PR, freely editable afterward, or supply your own before the first run
    • Header hierarchy (H1–H3 → separate pages; H4+ → in-page sections; ####+ → sidebar-included sections)
    • *{ query }* instruction blocks for AI-generated content alongside preserved static text
    • Header normalization (H4→H2, H5→H3, H6→H4 in rendered pages)
    • Slug generation rules (spaces→hyphens, special chars stripped)
    • Complete annotated example showing input PAGES.md → output files + generated _Sidebar.md

Example of the ####+ sidebar section syntax now documented:

# API Reference

*{ Overview of the API }*

####+ Authentication
*{ Describe auth flow }*

#### Internal Details
*{ Implementation details - not shown in sidebar }*

Content verified against the actual workflow implementation in workflows/agentic-wiki-writer.md.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI linked an issue Mar 13, 2026 that may be closed by this pull request
Co-authored-by: mrjf <180956+mrjf@users.noreply.github.com>
Copilot AI changed the title [WIP] Document wiki writer pages template format docs: document PAGES.md template format for agentic-wiki-writer Mar 13, 2026
Copilot AI requested a review from mrjf March 13, 2026 04:37
Copilot finished work on behalf of mrjf March 13, 2026 04:37
@mrjf mrjf marked this pull request as ready for review March 13, 2026 05:14
@mrjf mrjf merged commit c782200 into main Mar 13, 2026
1 check passed
@mrjf mrjf deleted the copilot/document-wiki-writer-pages-template branch March 13, 2026 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

document wiki writer pages template format

2 participants