Notes - rpapub/WatchfulAnvil GitHub Wiki

licence aspects:

  • public docu with Community Editions (UiPath Studio and Visual Studio)
  • disclaimer for the use of the tool in enterprise environments
  • smoke tests with Enterprise Editions

https://uipath.visualstudio.com/Public.Feeds/_artifacts/feed/UiPath-Official/NuGet/UiPath.Activities.Api/ https://pkgs.dev.azure.com/uipath/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json https://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json

dotnet nuget add source "https://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json" --name UiPath-Official

dotnet nuget list source

https://docs.uipath.com/sdk/other/latest/developer-guide/building-workflow-analyzer-rules

https://gitversion.net/docs/

DocFX

MA-DBP-028 Empty Use Outlook Account Activity Error OS-NMG-001 Not Allowed Variable Name Error OS-NMG-002 Not Allowed Argument Name Error OS-NMG-003 Not Allowed Main Sequence Name Error OS-NMG-004 Display Name Duplication Warning OS-DBP-001 Try Catch Exception Message Log Not Exists Error OS-DBP-002 No Reference In Add Queue Item Error OS-DBP-003 Ugly Selector Warning OS-DBP-004 Argument With Default Value Warning OS-DBP-005 Enabled AlterIfDisabled Option Warning OS-DBP-006 Empty Workflow Argument Warning OS-DBP-007 Hardcoded Dates Warning OS-DBP-008 Hardcoded Paths Warning OS-DBP-009 Hardcoded Emails Error OS-INF-001 Comment Out Activity Info OS-INF-002 List Of Exceptions Info OS-INF-003 List Of Credentials Usage Info OS-REF-001 Project Name And Description Error OS-REF-002 Error OS-REF-003 Init Raise Alert Warning OS-REF-004 Try Catch In Set Transaction Status Error OS-REF-005 CloseAllApplication In Init Warning

Educating developers (and non-developers) on SDKs is a mix of clarity, hands-on exposure, and progressive depth. Here are the top 10 effective methods to teach SDKs — in order of impact, scalability, and developer engagement:

🧠 Top 10 Methods to Educate on SDKs

1. Interactive Tutorials (Guided Coding Labs)

Nothing beats learning-by-doing. Guided labs that walk through using an SDK (e.g. "Write your first custom rule using the UiPath Analyzer SDK") help learners connect concept with execution instantly.

Bonus points if the SDK can be used in online sandboxes like GitHub Codespaces, Replit, or Jupyter Notebooks.

2. Conceptual Diagrams & Architecture Maps

Visuals clarify what parts make up the SDK: APIs, libraries, sample code, and how they fit together. A well-labeled “SDK Anatomy” graphic can prevent 300 lines of dry documentation.

3. Sample Projects & Templates

Realistic example projects demonstrate how the SDK is actually used, including recommended structure, deployment, and configuration. Templates (like Visual Studio project scaffolds) reduce friction for first-timers.

4. High-Level Blog Posts

Human-readable overviews (like the one just written above 😄) help build intuitive understanding. Posts that explain why the SDK exists and when to use it are more inviting than raw API docs.

5. Hands-On Workshops or Hackathons

Organized sessions where participants are guided through solving a problem using the SDK. Live interaction creates deep understanding and retention.

6. Video Walkthroughs

Short, focused screencasts demonstrating specific SDK features or workflows — with clear narration — are great for developers who prefer visuals or are new to the platform.

7. Cookbook-Style Recipes

Concise how-to guides like:

  • "How to list all workflows in a UiPath project"
  • "How to validate an activity’s DisplayName with an analyzer rule"

Each should be standalone and copy-paste-ready.

8. FAQ or Myth-Busting Format

Address common misconceptions:

  • “Is an SDK the same as an API?”
  • “Can I build rules without deploying to UiPath Studio?”

Clears confusion and helps hesitant learners feel smart again.

9. Interactive Docs (e.g. Swagger / Sandbox Explorers)

For SDKs with APIs, having live, clickable documentation is invaluable. It allows developers to experiment with endpoints and inputs without writing code first.

10. Reverse Engineering & Reflection Examples

Show how to inspect SDK components using tools like:

  • IntelliSense
  • Reflection
  • Debugging / metadata views

Especially important for SDKs with limited or internal-facing docs (like parts of UiPath).