Skip to content

docs: add activity dev guide#521

Merged
alexandru-petre merged 1 commit intodevelopfrom
docs/add_activity_dev_guide
Mar 6, 2026
Merged

docs: add activity dev guide#521
alexandru-petre merged 1 commit intodevelopfrom
docs/add_activity_dev_guide

Conversation

@adrianignat13
Copy link
Member

the documentation should be used by
AI agents or humans who want to develop
activities

the documentation should be used by
AI agents or humans who want to develop
activities
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a comprehensive activity development guide aimed at AI agents and human developers working with UiPath Community Activities. It includes a CLAUDE.md file for Claude Code guidance, updates to README.md with improved structure and corrected typos, and a detailed multi-file guide under .claude/activity-development-guide/ covering activity code patterns, ViewModel design, widgets, testing, and more.

Changes:

  • Updated README.md with improved structure, corrected typos (e.g., "depricating" → "deprecating"), and links to the new development guide
  • Added CLAUDE.md providing repository overview, build commands, architecture, and conventions for Claude Code
  • Added ~30 documentation files under .claude/activity-development-guide/ covering core architecture, runtime patterns, design-time ViewModels, widgets, testing, and advanced patterns

Reviewed changes

Copilot reviewed 41 out of 41 changed files in this pull request and generated no comments.

Show a summary per file
File Description
README.md Restructured with tree layout, build commands, link to dev guide, typo fixes
CLAUDE.md New file: Claude Code guidance with build commands, architecture, conventions
.claude/activity-development-guide/index.md Guide entry point with task-based and topic-based navigation
.claude/activity-development-guide/core/*.md Architecture, activity context, project structure, best practices
.claude/activity-development-guide/runtime/*.md Activity code patterns, platform API, orchestrator integration
.claude/activity-development-guide/design/*.md ViewModel, metadata, localization, validation, rules, bindings, etc.
.claude/activity-development-guide/design/widgets/*.md Widget reference docs (dropdown, autocomplete, filter-builder, etc.)
.claude/activity-development-guide/testing/*.md Activity testing and ViewModel testing patterns
.claude/activity-development-guide/advanced/*.md SDK framework, advanced patterns (bookmarks, retry, etc.)
.claude/activity-development-guide/reference/*.md Service access, feature flags, compilation constants
.claude/activity-development-guide/examples/complete-example.md Full worked example of an email sender activity package

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 6, 2026

@alexandru-petre alexandru-petre merged commit 3ed8129 into develop Mar 6, 2026
11 checks passed
@alexandru-petre alexandru-petre deleted the docs/add_activity_dev_guide branch March 6, 2026 16:58
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.

3 participants