Skip to content
Open
Show file tree
Hide file tree
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
54 changes: 54 additions & 0 deletions .agents/skills/stage-site/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: stage-site
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. 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
```

Alternatively, to verify all links between pages on the site work:

```bash
dart run dash_site check-links
```

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

## 2. 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
```

## 3. 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
```

## 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
```
18 changes: 15 additions & 3 deletions src/content/install/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,13 @@ then extract the SDK to where you want it stored.
-Destination $env:USERPROFILE\develop\
```

:::note
If the `flutter.bat` file is missing from the `bin` directory
after extraction, your antivirus software might have quarantined it.
If this happens, configure your antivirus to trust the Flutter SDK directory,
then extract the bundle again.
:::

{: .steps .windows-only}

1. <h3>Download the Flutter SDK bundle</h3>
Expand Down Expand Up @@ -319,7 +326,9 @@ the Flutter team recommends you first try out
<div class="card-grid link-cards">
<div class="card filled-card list-card">
<div class="card-leading">
<img src="/assets/images/decorative/flutter-on-phone.svg" height="160" aria-hidden="true" alt="A representation of Flutter on multiple devices.">
<img src="/assets/images/decorative/flutter-on-phone.svg"
height="160" aria-hidden="true"
alt="A representation of Flutter on multiple devices.">
</div>
<div class="card-header">
<span class="card-title">Set up a target platform</span>
Expand Down Expand Up @@ -350,7 +359,9 @@ the Flutter team recommends you first try out

<div class="card filled-card list-card">
<div class="card-leading">
<img src="/assets/images/decorative/pointing-the-way.png" height="160" aria-hidden="true" alt="Dash helping you explore Flutter learning resources.">
<img src="/assets/images/decorative/pointing-the-way.png"
height="160" aria-hidden="true"
alt="Dash helping you explore Flutter learning resources.">
</div>
<div class="card-header">
<span class="card-title">Learn Flutter development</span>
Expand All @@ -369,7 +380,8 @@ the Flutter team recommends you first try out

<div class="card filled-card list-card">
<div class="card-leading">
<img src="/assets/images/decorative/up-to-date.png" height="160" aria-hidden="true" alt="Keep up to date with Flutter">
<img src="/assets/images/decorative/up-to-date.png" height="160"
aria-hidden="true" alt="Keep up to date with Flutter">
</div>
<div class="card-header">
<span class="card-title">Stay up to date with Flutter</span>
Expand Down
Loading