91 lines (61 loc) · 2.02 KB

Basic code-wiki Workflow Examples

Project Work Without Explicit Invocation

Prompt:

Fix the failing auth test in this repository.

Expected behavior:

using-code-wiki runs as bootstrap because the request is project-related.
The agent checks whether wiki/ exists.
If a wiki exists, the agent reads only the relevant wiki pages.
Source inspection is narrowed by wiki paths and module context.
Before final response, the agent reports whether wiki updates were needed.

Create A Wiki

Prompt:

Use creating-code-wiki to initialize a wiki for this repository.

Expected behavior:

Inspect source, tests, config, and docs.
Create canonical wiki pages.
Create domain-based modules/<domain-slug>.md pages.
Avoid broad modules when real domains are visible.

Read Before Editing

Prompt:

I need to change login behavior.

Expected behavior:

using-code-wiki checks for an existing wiki first.
Read wiki/index.md first.
Read modules/index.md and likely auth/security pages.
Report source paths that need verification.

Explore Code With Wiki Context

Prompt:

Use exploring-code-with-wiki to inspect only the files needed for the document ingestion path.

Expected behavior:

Start from wiki paths.
Inspect referenced code and nearby tests.
Expand search only through named dependencies.
Note stale wiki claims if source code differs.

Update After Change

Prompt:

I changed API-token scopes. Finish the task.

Expected behavior:

using-code-wiki closeout detects a wiki-relevant change.
Identify affected canonical pages and module pages.
Preserve existing filenames and section roles.
Update impact, verification, and gotchas.
Append wiki/log.md.

Audit Existing Wiki

Prompt:

Use auditing-code-wiki to check whether this wiki is useful for future agents.

Expected behavior:

Check filename consistency, domain split, evidence, context waste, and stale links.
Report findings with evidence and suggested fixes.