Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .agents/skills/validate-pr/SKILL.md
Copy link
Member

@parlough parlough Mar 12, 2026

Choose a reason for hiding this comment

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

Maybe we should consider a different name and description for this skill? It slightly conflates the meaning of the word "staging": what the skill discusses and then its step 4, which is also staging the site. I wonder that could be a bit confusing.

Would this skill be better described as something like "Validate(or check?) your changes [to the site] [before committing]"?

Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: validate-pr
description: >-
Stages the Flutter site locally. This includes checking for broken links,
verifying excerpts, updating formatting, and serving the dev site.
---

# Stage the Flutter site

Before committing changes or reviewing a PR locally,
it is important to stage the site and ensure everything works correctly.
Follow these steps to stage the site:

## 1. Sync code excerpts

Ensure that any changed code excerpts are properly run and synced to the
Markdown files:

```bash
dart run dash_site refresh-excerpts
```

## 2. Update formatting

Update the formatting of the site examples and tools to ensure
they follow the official Dart format:

```bash
dart run dash_site format-dart
```

## 3. Check for broken links

Run the following command to check for any unlinked or broken
Markdown link references in the site output:

```bash
dart run dash_site check-link-references
```

If any broken links are found, try to patch them or alert the user.

## 4. Stage the site locally

Finally, serve a local development server of the site so the user can preview the changes:

```bash
dart run dash_site serve
```
Loading