Skip to content

docs:(APPS-35839) add skills for the remaining ui-widgets packages - #2540

Open
shivendra6720 wants to merge 2 commits into
mainfrom
docs/coded-apps-ui-widget-guides
Open

docs:(APPS-35839) add skills for the remaining ui-widgets packages#2540
shivendra6720 wants to merge 2 commits into
mainfrom
docs/coded-apps-ui-widget-guides

Conversation

@shivendra6720

@shivendra6720 shivendra6720 commented Aug 10, 2026

Copy link
Copy Markdown

What

Adds references/widgets/ guides for the 5 remaining @uipath/ui-widgets-* packages — conversational-agent-chat, datatable, multi-file-upload, pdf-viewer, external-auth — following the validation-station pattern: SKILL.md navigation rows, an oauth-scopes Widgets section (replaces the standing TODO), scaffold cross-links in create-web/action-app, and prefer-the-widget pointers in the SDK references.

How it was tested

  • npm run skills:validate + description hook green; all relative links resolve.
  • Skill routing verified via a local plugin install (chat prompt → skill activates → reads the widget guide → output follows its critical rules).
  • Live on alpha: chat, datatable, and pdf-viewer built and verified against a real tenant (multi-file-upload verified with a repo-built tarball — see below). Doc fixes from those runs are folded in (scope delimiter trap, Vite optimizeDeps pair, numeric folder-id lookup).

Reviewer notes

  • pdf-viewer and external-auth are not on npm yet — their guides open with a mandatory publish check and a fallback.
  • Published multi-file-upload@1.0.0 is broken on SDK ≥1.5 (telemetryClient.track); its guide carries a warning until the republish.
  • Eval tasks for the new guides deferred to a follow-up PR (same as validation-station).

Add references/widgets/ guides for conversational-agent-chat, datatable,
multi-file-upload, pdf-viewer, and external-auth, mirroring the
validation-station integration pattern: SKILL.md navigation rows, an
oauth-scopes Widgets section (replaces the standing TODO), scaffold
cross-links, and prefer-the-widget pointers in the SDK references.

Live-tested against alpha; folds in the resulting fixes: the
comma-vs-space scope delimiter trap in oauth-client-setup, publish-status
warnings for the unpublished (pdf-viewer, external-auth) and
runtime-broken published (multi-file-upload 1.0.0) packages, the Vite
optimizeDeps exclude+include pair for pdf-viewer, and the numeric
folder-id lookup recipe.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@UiPath UiPath deleted a comment from github-actions Bot Aug 10, 2026
@shivendra6720 shivendra6720 changed the title docs(uipath-coded-apps): add guides for the remaining ui-widgets packages docs:(APPS-35839) add skills for the remaining ui-widgets packages Aug 10, 2026

Signatures/params/examples for services, event-helper classes, options, enums: `dist/conversational-agent/index.d.ts`. Per-method scopes: shipped `docs/oauth-scopes.md`. This file covers only what neither can express.

> **Building a chat UI?** The `@uipath/ui-widgets-conversational-agent-chat` widget ships the complete chat experience (streaming, attachments, history, feedback) — embed it instead of hand-wiring: [../widgets/conversational-agent-chat.md](../widgets/conversational-agent-chat.md). Use this file when the widget's UI cannot express the requirement.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mention something like "Building a chat UI with conversational agent?"

Comment thread skills/uipath-coded-apps/SKILL.md Outdated
- User asks about `uip codedapp` commands, `.uipath/` directory, `app.config.json`, or `action-schema.json`
- User wants to **scaffold** a new React/Vue frontend for UiPath Cloud or an Action Center form
- User wants to embed the **Document Understanding Validation Station** widget for human review of DU extraction results
- User wants to embed a **`@uipath/ui-widgets-*` widget**: DU Validation Station (human review of DU extraction results), Conversational Agent chat, Data Fabric DataTable, multi-file bucket upload, PDF viewer, or external-IdP sign-in

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User doesnt know about @uipath/ui-widget-*, so how would they "want" to embed that. Change the sentence.

… wording

Rephrase the SKILL.md when-to-use bullet around user goals instead of the
@uipath/ui-widgets-* package namespace users don't know, and make the
conversational-agent redirect lead-in explicit ("chat UI with a
conversational agent"). Per maninder-uipath's review on #2540.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.

2 participants