Skip to content

Comments

Architecture skill with Mermaid pattern documentation#11281

Open
brooke-hamilton wants to merge 7 commits intoradius-project:mainfrom
brooke-hamilton:brooke-hamilton/architecture-skill
Open

Architecture skill with Mermaid pattern documentation#11281
brooke-hamilton wants to merge 7 commits intoradius-project:mainfrom
brooke-hamilton:brooke-hamilton/architecture-skill

Conversation

@brooke-hamilton
Copy link
Member

@brooke-hamilton brooke-hamilton commented Feb 20, 2026

Description

Adds the architecture-documenter skill to the Radius Copilot CLI with comprehensive Mermaid diagram patterns and examples.

The prompt used to create this skill used the /create-skill prompt that is currently bundled with VS Code Insiders. Here is what that prompt was given:

/create-skill Create a skill in the radius project that is very good at documenting application architectures. 
- It is an expert at abstracting the application architecture and generating understandable mermaid diagrams. 
- When asked it can go much deeper into the detailed interactions. It is especially good at producing true-to-code sequence diagrams (mermaid) and component diagrams that show entity relationships.
- It can distill ccomplex code concepts into simple to understand human readable text.
- It can dive deep into existing code, especially golang, to figure out how things work.
- It can suggest archtitectural improvements that would simplify the code.
- It can answer questions about the existing architecture

A follow-up prompt was useful in filling out the High Level Components section:

validate the "High-Level Components" section. 
- Are those paths and names correct? If not, fix them.
- Are there more paths and names that should be added?

Type of change

  • This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).

Contributor checklist

  • An overview of proposed schema changes is included in a linked GitHub issue.
    • Not applicable
  • A design document PR is created in the design-notes repository, if new APIs are being introduced.
    • Not applicable
  • The design document has been reviewed and approved by Radius maintainers/approvers.
    • Not applicable
  • A PR for the samples repository is created, if existing samples are affected by the changes in this PR.
    • Not applicable
  • A PR for the documentation repository is created, if the changes in this PR affect the documentation or any user facing updates are made.
    • Not applicable
  • A PR for the recipes repository is created, if existing recipes are affected by the changes in this PR.
    • Not applicable

Changes

  • Added arch-documenter skill with SKILL.md documentation
  • Added Mermaid pattern references for architecture diagrams

Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
@brooke-hamilton brooke-hamilton requested a review from a team as a code owner February 20, 2026 20:22
Copilot AI review requested due to automatic review settings February 20, 2026 20:22
@brooke-hamilton brooke-hamilton requested a review from a team as a code owner February 20, 2026 20:22
Copy link
Contributor

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

Adds a new arch-documenter Copilot skill under .github/skills/ to help generate code-grounded architecture documentation, including reusable Mermaid diagram templates.

Changes:

  • Added arch-documenter skill definition and guidance (SKILL.md)
  • Added a Mermaid diagram patterns reference document with reusable templates

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
.github/skills/arch-documenter/SKILL.md Defines the skill’s purpose, procedure, Radius-specific context, and a recommended output format.
.github/skills/arch-documenter/references/mermaid-patterns.md Provides reusable Mermaid diagram templates and diagramming tips.

@brooke-hamilton brooke-hamilton assigned Copilot and unassigned Copilot Feb 20, 2026
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Copy link
Contributor

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

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

Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
@codecov
Copy link

codecov bot commented Feb 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 50.98%. Comparing base (209adb7) to head (ce8c9fa).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11281   +/-   ##
=======================================
  Coverage   50.98%   50.98%           
=======================================
  Files         679      679           
  Lines       43174    43174           
=======================================
+ Hits        22012    22013    +1     
+ Misses      19040    19038    -2     
- Partials     2122     2123    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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