refactor(uipath-rpa): consolidate co-read references (Stage 1)#2084
refactor(uipath-rpa): consolidate co-read references (Stage 1)#2084AlvinStanescu wants to merge 7 commits into
Conversation
Merge co-read references (12 modern + 3 assets + 8 legacy files absorbed), trim duplicated content, keep every file under ~12k tokens. Cuts 2-4 reference-read turns per task. Stage 2 (SKILL.md slim) stacks separately. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- xaml-basics-and-rules.md absorbs workflow-guide.md (authoring phases); IS ConnectorActivity internals move to is-connector-xaml-guide.md - canvas-layout-guide.md absorbs flowchart-guide.md + x:Reference wiring rules from common-pitfalls.md (single node-registration treatment) - csharp-activity-binding-guide.md absorbs csharp-expression-pitfalls.md (XAML-C# vs coded-C# scope preamble preserved) - is-connector-xaml-guide.md absorbs connector-capabilities.md (~70% duplicate) + IS gotchas from common-pitfalls.md - common-pitfalls.md: delete byte-identical duplicated Array-Types section; move UIA/IS/x:Reference/CLI sections to their domain files Each merged file stays ~12k tokens or below; co-read pairs now cost one Read instead of two. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- ui-automation-guide.md absorbs uia-prerequisites.md (version gate + upgrade-consent rules) and the UIA XAML gotchas from common-pitfalls; sheds OR-as-UI-Library to library-authoring-guide.md; stub-pattern and nested-card examples compressed (full nested-card XAML lives in uia-configure-target-workflows.md) - uia-configure-target-workflows.md absorbs uia-elements-interaction-guide.md as § Driving Captured Controls Rule 7/7a flows now cost two reads instead of four. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- operations-guide.md absorbs coding-guidelines.md as § Coding Guidelines (the 'add/edit coded workflow' chain becomes one read) - codedworkflow-reference.md absorbs inspect-package-guide.md + third-party-packages-guide.md; fixes the broken 'references/<service>/examples.md' pointer and wires the bundled activity-docs coded/ folders as the documented third-tier fallback (.local/docs coded-api.md -> packages inspect -> bundled coded docs) - integration-service-guide.md: cross-skill file links replaced with self-contained uip is CLI pointers (graceful uipath-platform delegation) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- cli-reference.md absorbs validation-guide.md (iteration loop, smoke test, build-vs-validate matrix) and publishing-guide.md (pack/upload flow); cross-skill deep links replaced with skill-name pointers; analyzer-rules on-demand guidance deduplicated - environment-setup.md absorbs project-structure.md + project-structure-guide.md (kills the confusing near-duplicate names) - assets/codedworkflow-template.md absorbs testcase/helper-utility/ before-after-hooks templates (full boilerplate kept - template exemption); duplicated using-statements note dropped - testing-guide.md: fileInfoCollection JSON + Test Manager command block deduplicated to their canonical homes (json-template.md, cli-reference.md § Test Manager) - removes drift risk - uipath-test publish-and-link-guide.md inbound link retargeted to cli-reference.md § Pack & Publish (publishing-guide.md absorbed) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- legacy/cli-reference.md absorbs environment-setup, project-structure, discovery-workflow, validation-and-fixing (legacy project creation: 5 reads -> 1) - legacy/xaml-basics-and-rules.md absorbs common-pitfalls (VB cheat-sheet and deprecated-activity table deduplicated to _PATTERNS.md pointers) - legacy/selector-guide.md absorbs activity-docs/UIAutomation.md - legacy/testing-guide.md absorbs test-data-guide + activity-docs/Testing.md - remove hardcoded personal path (C:\Users\alexandru.roman\...) from _REFRAMEWORK.md and _DU-PROCESS.md; forum/academy Sources link dumps reduced to official docs links - legacy-mode-guide.md router + _INDEX.md retargeted to merged locations Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… files - SKILL.md Task Navigation chains collapsed to single reads where the pair merged; every reference link resolves post-merge - bundled coded activity-docs wired as third-tier fallback in the Coded Quick Reference (user-requested: keep + link, not delete) - 19 inbound links from unmodified files retargeted; 2 pre-existing broken anchors fixed (#expression-language, LRW x:Reference pointer) - pre-existing unclosed code fences (trailing ``` on command lines) fixed in cli-reference, codedworkflow-reference, integration-service - link+anchor integrity verified: 0 problems across 700 markdown files Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Claude finished @AlvinStanescu's task in 13m 4s —— View job PR Review: refactor(uipath-rpa): consolidate co-read references (Stage 1)
SummaryMechanical reference-consolidation PR that merges 23 always-co-read files into their logical survivors, deletes the absorbed originals, and retargets all inbound links (including SKILL.md's Task Navigation table). The merge map is well-reasoned — files paired by actual co-read patterns — and the execution is thorough. Net effect: −578 lines, fewer sequential Change-by-Change Review1.
|
| File | Lines |
|---|---|
legacy/cli-reference.md |
960 |
xaml/canvas-layout-guide.md |
790 |
xaml/xaml-basics-and-rules.md |
776 |
xaml/common-pitfalls.md |
767 |
coded/operations-guide.md |
677 |
ui-automation-guide.md |
574 |
legacy/testing-guide.md |
552 |
environment-setup.md |
502 |
cli-reference.md |
500 |
legacy/selector-guide.md |
488 |
is-connector-xaml-guide.md |
464 |
coded/codedworkflow-reference.md |
431 |
assets/codedworkflow-template.md |
415 |
uia-configure-target-workflows.md |
287 |
library-authoring-guide.md |
263 |
xaml/csharp-activity-binding-guide.md |
162 |
Content absorption is correct across all files. The byte-identical 34-line duplicated section in common-pitfalls.md was properly removed. NGetText skip-tax now stated once (was 4×). Deduplication in testing-guide.md, debugging.md, and is-connector-xaml-guide.md all clean.
3. references/legacy/cli-reference.md:784-803, 941-960 — duplicate troubleshooting
Severity: Medium
Two absorbed files both contained the same 5-item troubleshooting list:
- Lines 784-803:
### Troubleshooting(fromdiscovery-workflow.md— condensed) - Lines 941-960:
### Common Error Scenarios(fromvalidation-and-fixing.md— slightly more detailed)
One should be removed. The more detailed version at 941-960 is the better survivor.
4. references/coded/operations-guide.md:545-556 — empty heading + duplicate API Discovery
Severity: Medium
The absorption of coding-guidelines.md introduced two issues:
- Line 545:
### Best Practicesis an empty heading with no content before the next heading. The originalcoding-guidelines.mdhad## Best Practicesas a parent with### API Discoveryas child; when demoted one level, both landed at###, leaving Best Practices empty. - Line 547-556:
### API Discoveryis a condensed version of the full## API Discovery (Before Creating Workflows)at line 288 — content overlap.
Fix: either remove ### Best Practices and the duplicate ### API Discovery (lines 545-556) entirely since line 288 covers it in full, or demote the API Discovery sub-items to #### and trim to a back-reference.
5. references/coded/operations-guide.md:590 — stale merge artifact
Severity: Medium
Line 590 contains @../validation-guide.md — a bare text reference (not a markdown link) carried over from the absorbed coding-guidelines.md. The target validation-guide.md was deleted in this PR. Should be removed or converted to a link to cli-reference.md § Validation Iteration Loop.
6. xaml/csharp-activity-binding-guide.md:128,141,145 — heading hierarchy
Severity: Low
Three ## headings should be ### to nest under the ## C# Expression Pitfalls parent at line 124. The original csharp-expression-pitfalls.md used ## as top-level; when absorbed under a new ## C# Expression Pitfalls parent, the sub-headings weren't demoted.
- Line 128:
## Attribute-form expressions fail at runtime→### - Line 141:
## `OutArgument<T>` attribute form fails at parse time→### - Line 145:
## ThrowIfNotInTree at runtime — two causes→###
7. assets/codedworkflow-template.md — stale code comment references (pre-existing)
Severity: Low
Ten in-code comments say // Add service-specific usings as needed — see references/coding-guidelines.md. The path was already wrong before this PR (missing coded/ subdirectory). The header-level markdown link at line 5 was correctly updated to operations-guide.md § Coding Guidelines, but the in-code comments were not.
8. xaml/canvas-layout-guide.md:143-145 — double horizontal rule
Severity: Low
Two consecutive --- from merge boundary (new section ends with ---, old content started with ---). Cosmetic only; remove one.
9. Cross-skill touch: skills/uipath-test/references/publish-and-link-guide.md
Severity: OK
Single line retargeted from publishing-guide.md (deleted) to cli-reference.md#pack--publish-to-orchestrator. Anchor resolves. Pre-existing cross-skill reference pattern preserved.
10. Fixes bundled in this PR
Severity: OK (all improvements)
- Personal path
C:\Users\alexandru.roman\...removed from_REFRAMEWORK.mdand_DU-PROCESS.md— confirmed clean. - Cross-skill file links in
coded/integration-service-guide.mdproperly converted to inline CLI commands with graceful delegation text. - Unclosed code fence in
integration-service-guide.md:260fixed. testing-guide.mdproperly deduplicated (Test Manager commands → pointer, JSON block → pointer).docs/uipath-rpa-v2.md— well-structured plan document, appropriate fordocs/.
What's Missing
Nothing blocking. The three Medium findings are small mechanical fixes (remove duplicate section, remove empty heading + duplicate content, fix stale artifact). The three Low findings are polish.
Area Ratings
| Area | Status | Notes |
|---|---|---|
| Frontmatter | OK | Untouched — valid name, description under 1024 chars |
| E2E Tests | OK | No new capabilities; existing tests unaffected |
| Skill Body | OK | All 30+ SKILL.md anchor retargets verified |
| References & Assets | Minor Issues | 3 Medium (duplicates, stale artifact) + 3 Low (heading hierarchy, comments, formatting) |
| Repo Hygiene | OK | Scoped changes, CODEOWNERS covers path, no secrets |
Issues for Manual Review
- Merge conflict with PR feat(uipath-rpa): execution maps + pattern card — cut greenfield builds from ~36-40 to ≤10 turns #1827 (
feat/uipath-rpa-execution-maps): documented, whichever lands second rebases. - Three files 3–6% over the soft ~12k token cap: justified tradeoff (one fewer Read per flow); splitting back would re-add turns.
- A/B comparison (
/skill-compare): recommended before merge to confirm the hypothesis that merged references reduce turns without reducing success rate.
Conclusion
High-quality mechanical refactoring PR with thorough link retargeting. Three Medium findings should be fixed before merge — all are small: (1) duplicate troubleshooting in legacy/cli-reference.md, (2) empty heading + duplicate API Discovery in coded/operations-guide.md, (3) stale @../validation-guide.md artifact. Three Low findings are nice-to-fix. Recommend approval after the Medium fixes.
|
What
Merges uipath-rpa reference files that agents always read together in the same task flow, so each flow costs fewer sequential `Read` turns. 23 files absorbed (12 modern references, 3 asset templates, 8 legacy files), every merged file stays at or near the ~12k-token soft cap, and all inbound links (including SKILL.md's Task Navigation) are retargeted. Full plan + measured results: docs/uipath-rpa-v2.md.
Reads per flow (before → after): XAML create 6–9 → 4–5 · UIA 3–4 → 2 · coded 3–5 → 1–2 · Flowchart 3–4 → 2 · IS-connector XAML 2 → 1 · legacy project create 5 → 1.
Merge map
cli-reference.mdvalidation-guide.md,publishing-guide.md, CLI pitfalls §xaml/xaml-basics-and-rules.mdxaml/workflow-guide.md(IS internals moved out)xaml/canvas-layout-guide.mdxaml/flowchart-guide.md, x:Reference wiring §xaml/csharp-activity-binding-guide.mdxaml/csharp-expression-pitfalls.mdui-automation-guide.mduia-prerequisites.md(+UIA XAML gotchas; OR-UI-Library § → library guide)uia-configure-target-workflows.mduia-elements-interaction-guide.mdcoded/operations-guide.mdcoded/coding-guidelines.mdcoded/codedworkflow-reference.mdcoded/inspect-package-guide.md,coded/third-party-packages-guide.mdenvironment-setup.mdproject-structure.md,project-structure-guide.mdis-connector-xaml-guide.mdconnector-capabilities.md(~70% duplicate)assets/codedworkflow-template.mdcli-reference.md← 4 files ·xaml-basics-and-rules.md←common-pitfalls.md·selector-guide.md←UIAutomation.md·testing-guide.md←test-data-guide.md+Testing.mdFixed along the way
Verification
Known interactions
🤖 Generated with Claude Code