updatewiki Quick Reference
Version 1 · Publish updatewiki command patterns and practical examples
Historical versionupdatewiki Quick Reference
Invocation
In Codex, use $updatewiki for explicit invocation or begin a request with updatewiki.
In Claude Code, use /updatewiki for explicit invocation or begin a request with updatewiki.
updatewiki requests change the KB. findwiki requests search or read it without publishing a
new version.
Common requests
| Request | Result |
|---|---|
updatewiki create project documentation |
Inspect the current repository, create its KB project if needed, then create useful initial pages. |
updatewiki <page> with <file.md> |
Read the complete Markdown file and merge it into the named page. |
updatewiki <page>: <information> |
Merge inline information into the named page. |
updatewiki with <file.md> |
Inspect the file and existing pages, then choose the best page. |
updatewiki from this task |
Inspect the task, repository status, diff, tests, and configuration; update every materially affected page. |
findwiki <question> |
Search and retrieve QDG KB knowledge without changing it. |
<page> may be a page slug, title, conventional type, or quoted page name.
Standard page types
| Page type | Use it for |
|---|---|
overview |
Purpose, scope, architecture, dependencies, and starting points. |
changelog |
Delivered changes, version numbers, fixes, and known issues. |
workflow |
Repeatable development or operational procedures. |
faq |
Recurring questions and durable answers. |
bugs |
Defects, symptoms, causes, workarounds, and resolutions. |
notes |
Durable findings that do not yet belong elsewhere. |
user-guide |
Detailed setup, learning, and operating instructions. |
quick-reference |
Compact commands, syntax, examples, and caveats. |
general |
A named topic that does not fit a conventional type. |
Examples
Create documentation for the current repository
updatewiki create project documentation
Update a changelog from a file
updatewiki changelog with release-1.4.0.md
Add a FAQ answer inline
updatewiki faq: How do I run locally? Use scripts\bootstrap.ps1, then scripts\run-local.ps1.
Record a bug report
updatewiki bugs with login-timeout-bug.md
Update a workflow page
updatewiki "Production Deployment" with deployment-workflow.md
Publish a detailed user guide
updatewiki user guide with docs\user-guide.md
Publish a quick reference
updatewiki quick reference with docs\quick-reference.md
Capture completed development work automatically
updatewiki from this task
Search without changing anything
findwiki how is QDG KB connected to QWebHub?
What the skill does automatically
- Matches the current repository to a QDG KB project.
- Reads the current page before changing it.
- Merges new information while preserving accurate existing content.
- Publishes the complete Markdown as a new immutable version.
- Uses the current page version to prevent concurrent overwrites.
- Reports the project, page, new version, and change description.
Important rules
- Do not include credentials, tokens, private keys, or database configuration contents.
- Give the skill enough context to identify the project. Run it from the project repository when possible.
- Quote a multi-word page title:
updatewiki "Deployment Notes" with notes.md. - For a new page, the skill uses version
0as the expected version. - For an existing page, it reads and supplies the current version.
- On a version conflict, it rereads, merges, and retries once.
- Restoring an old version creates a new version; history is never rewritten.
Success checklist
- The response identifies the intended project.
- The response identifies the page and page type.
- A write reports a new version number and change description.
- Reading the page returns the newly published content.
- Page history retains earlier versions.