QUI Docs
Install the QUI Documentation Authoring plugin when you want Codex to draft, revise, or review documentation pages. The plugin gives Codex two documentation-specific skills:
- write-docs: guidelines for writing MDX pages
- review-docs: guidelines for reviewing MDX pages
Prerequisites
- Enable the Qualcomm UI Codex marketplace.
- Reload plugins after installing so the skills load into the session.
Install the plugin
-
In Codex, open the plugin browser:
/plugins -
Search for
qui. -
Install qui-docs.
-
Start a new Codex thread.
Use the writing skill
Ask Codex to use the writing skill when creating or revising documentation:
Use the qui docs plugin to write a setup guide for this integrationCodex should load qui-docs:write-docs, read the plugin's authoring principles
and rules, determine the page type, write with reader value in the first
paragraph, and update qui-docs.config.ts when navigation changes.
Use the review skill
Ask Codex to use the review skill before submitting documentation changes:
Use the qui docs plugin to review the documentation changes in this branchCodex should load qui-docs:review-docs, list the files under review, check the
Reviewer Rejection Gates, and report findings with file and line references. If
there are no issues, Codex should still list any residual verification gaps.
When to use the plugin
Use this plugin for changes to MDX route files, qui-docs.config.ts, navigation
entries, examples, screenshots, documentation links, and docs assets in a QUI
Docs site.
Do not use this plugin as the only validation for code snippets. The plugin checks the documentation rules, but code snippets and CLI examples still need to be run or compiled when feasible.
Troubleshoot plugin usage
If Codex does not load a qui-docs:* skill, confirm that qui-docs is
installed from the /plugins view, then run /reload-plugins.
If the skills still do not appear, start a new Codex session.
Keep the plugin up to date by running the upgrade command regularly:
codex plugin marketplace upgrade qualcomm-uiIf Codex writes a page without applying the QUI Docs rules, ask it to use the QUI Docs plugin explicitly and rerun the review skill before submitting the change.