Codexqa Code Wiki

Code Wiki

Local architecture knowledge graph: index first, then export community digests with wiki inputs and write a DeepWiki-style HTML wiki report (sidebar + article + on-this-page TOC, module map, reading guides).

There is no codexqa wiki without --no-llm in this skill, and no wiki embed / query wiki. Those call a model or need an embedded wiki. The graph facts are already in wiki inputs JSON:

index  →  wiki inputs (architecture / overview / page / visualization)  →  HTML report

Pick the scenario before acting. Do not run wiki commands until an index exists. Do not send system / user prompt strings to another model. README.md / README.zh-CN.md are human-facing. Do not load them at runtime.

Documents (load on demand)

Read this file first. Read another file only when the row below applies. Do not preload the whole tree.

| File | Load when | |---|---| | SKILL.md (this file) | always: routing, report contract, reject conditions | | [references/playbook.md](references/playbook.md) | entering a scenario (index health / map / module / guide / persist) | | [references/report.md](references/report.md) | before writing the HTML file | | [assets/report-template.html](assets/report-template.html) | copy this file; do not invent a new layout | | [references/diagrams.md](references/diagrams.md) | before drawing; copy init and classDef verbatim | | [references/cli.md](references/cli.md) | CLI missing, PATH, or maintenance | | README.md, README.zh-CN.md | human-facing; not needed by the agent |

Scenario routing

Open [references/playbook.md](references/playbook.md) and jump to the named section.

| User is asking… | Playbook section | |---|---| | What is this repo / module map / knowledge graph | Map the repository (index health first) | | How is the system organized / architecture wiki | Map the repository | | What does this module do / who does it talk to | Explain one module | | Where should I start reading / guided path | Reading guide | | Persist a rule-only wiki for the UI | Persist rule-only wiki | | Empty results / missing index / wiki failed | Index health / Wiki blockers |

Change review, callers, test gaps, and stack traces belong to codexqa-code-analyzer.

Report contract

Deliver a self-contained HTML knowledge-graph report in DeepWiki wiki layout (left sidebar tree, article, on-this-page TOC) using the same daytime HTML chrome as codexqa-testcase-generator (light default, 中文/EN and 白天/黑夜 toggles, green accent #0f6b4c). Copy [assets/report-template.html](assets/report-template.html) into the working directory, then fill slots with Edit (do not rewrite CSS). Default the filled report to Simplified Chinese (headings, overview, guides, notes). Show community aliases as P01 (capitalize the leading p). Keep symbol names as-is. Write for a newcomer: what the system is, where to start, which module is the hub, which pages are standalone. Not a product brochure, and not an Archify / architecture canvas. Read [references/report.md](references/report.md) before writing the file. Read [references/diagrams.md](references/diagrams.md) before drawing. A diagram that misses the quality bar fails the report.

Report body (HTML slots) is only these blocks:

• How the system works (from overview / architecture input, in plain language)
• Module map (community ids, human titles, real deps)
• Layers / data flow (same modules, grouped Entry → Storage; no invented edges)
• Reading path (only steps backed by a real dependency)
• Module notes (responsibility / public API / internal calls / cross-module traffic)
• Peripheral modules (empty deps — do not force them into a layer)
• Architecture diagram: at least one Mermaid block in .diagram, and it must pass the quality bar
• Fill the sidebar tree (#nav-entry / #nav-app / #nav-domain / #nav-storage / #nav-modules / #nav-peripheral) so it looks like a DeepWiki wiki, not 8 flat links

Trust only the input object on each wiki inputs row. system / user are prompt templates, not evidence. page rows carry the digest; visualization / architecture / overview use rule titles and have no model-written body.

Reject the whole report and rewrite if any of these hold:

• Written as a generic project review (product intro, use cases, scored pros/cons)
• Evidence comes from README / a website / guesswork, not this run of wiki inputs
• Invented a module, group, or edge that is not in communities / deps / cross_community / visualization candidates
• Put an isolated module (empty deps) into a functional layer
• Ran codexqa wiki without --no-llm, or ran wiki embed / query wiki
• Mermaid is missing the paper init, the three classDef lines, or a core module that should be risk has no class ... risk
• Architecture subgraph titles are package names (Renderer / Compiler / Shared) instead of Entry → Application → Domain → Storage
• HTML is missing the bundled wiki chrome (sidebar + article + TOC), or was written from scratch instead of copying the template
• Report was delivered as Markdown-only / chat-only with no HTML file
• Archify / grouped-swimlane architecture canvas was generated (this skill does not ask for that)
• Chrome or body left in English when the user did not ask for English (overview / pages selected)
• Overview dumps field names (deps, cross_community, wiki inputs) instead of responsibility / dependency / reading order

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: openqa-cn
• Source: openqa-cn/codexqa
• License: Apache-2.0
• Homepage: https://openqa.cn

Install and usage instructions live in the source repository linked above.