wind docs.instructions.md

A set of documentation instructions for Wind, a Flutter UI toolkit, covering how widget and concept reference pages should be organized and illustrated.

In plain words
What is it for?
Use it when writing or updating widget documentation, usage examples, property tables, styling examples, previews, and related links.
Why use it?
It gives documentation contributors a consistent page structure and connects written guidance with runnable example screens.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/fluttersdk/wind/docs
Clone the repo
git clone --depth 1 https://github.com/fluttersdk/wind

Made for: GitHub Copilot.

Per session 933 This file is loaded in full into every session.
When invoked 933 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00933 $0.00933
Opus 5 $0.00466 $0.00466
Sonnet 5 $0.00187 $0.00187
Haiku 4.5 $0.00093 $0.00093

Measured yesterday against content hash 1e5d554a2ecb, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

wind docs.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/docs.instructions.md · 119 lines

How it starts

The opening of the file, as written. The whole thing — 119 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation conventions (doc/)

The doc/ directory is the user-facing markdown reference, organized by topic (widgets/, layout/, styling/, getting-started/, theming/, etc.). It is paired with example/lib/pages/ via <x-preview> tags.

File shape (every doc file)

# WFoo

One-line description of what the widget / concept does.

## Table of Contents

- [Basic Usage](#basic-usage)
- [Props](#props)
- [Styling Examples](#styling-examples)
- [Related Documentation](#related-documentation)

<a name="basic-usage"></a>
## Basic Usage

<x-preview path="widgets/w_foo_basic" size="md" source="example/lib/pages/widgets/w_foo_basic.dart"></x-preview>

```dart
WFoo(
  className: 'p-4 bg-blue-500 dark:bg-blue-700 rounded-lg',
  child: WText('Hello'),
)

Props

Prop Type Default Description
className String? null Wind utility classes.
child Widget? null Single child. XOR with children.
onTap VoidCallback? null Required for interactive variants.

  • WAnchor — auto-wraps when className contains state prefixes.

## Heading hierarchy

- `#` (single) — page title (widget or concept name). Exactly one per file.
- `##` — main sections (Basic Usage, Props, Styling Examples, Related Documentation, etc.).
- `###` — subsections within a section.
- Never skip levels.

## Section anchors

Place `<a name="section-name"></a>` immediately BEFORE every `##` heading. ToC links use the same slug. Slugs are kebab-case.

## x-preview tags

```html
<x-preview path="category/file_name" size="md" source="example/lib/pages/category/file_name.dart"></x-preview>
  • path matches example/lib/pages/{path}.dart WITHOUT the extension. Underscores in the file name carry over.
  • source is the FULL path from the repo root.
  • size: sm (compact), md (standard), lg (full-width).
  • Every x-preview MUST point to a real example/lib/pages/ file. If you add an x-preview, add or extend the example page in the same change.

Read the full file on GitHub · 119 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 119 lines · 933 tokens per session scan A 1e5d554a2ecb

Subscribe to this mod's changes

wind docs.instructions.md is an instructions file published in the GitHub repository fluttersdk/wind (33 stars, last pushed 2d ago), licensed MIT. It adds 933 tokens to every session, about $0.0047 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

pin_code_fields CLAUDE.md

Claude Code instructions for adar2378/pin_code_fields, covering claude.md, project overview, monorepo structure, development commands and with melos (recommended).

adar2378/pin_code_fields · 2,294 tokens

gpt_image_playground AGENTS.md

Instructions for CookSleep/gpt_image_playground, covering agent instructions for gpt-image-playground, 项目概况, 常用命令, 代码风格(强制) and 简单优先.

CookSleep/gpt_image_playground · 2,131 tokens

ui-beats AGENTS.md

Instructions for nikhils4/ui-beats: This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in nodemodules/next/dist/docs/ (resolved from this file's directory; in monorepos the next package may not be visible from the repo root) before…

nikhils4/ui-beats · 154 tokens

dart_agent_core AGENTS.md

Instructions for memex-lab/dart_agent_core, covering agents.md, common commands, transcript viewer cli (reads eval traces), two public libraries and architecture (big picture).

memex-lab/dart_agent_core · 1,450 tokens

sanad-agent AGENTS.md

Instructions for EastStarAI/sanad-agent, covering sanad agent repository contract, 1. documentation hierarchy, rules for ai agents and developers, 1.1. the strict separation pact and 1.2. the living project wiki & incremental documentation.

EastStarAI/sanad-agent · 3,115 tokens

dart-expert-skills copilot-instructions.md

Instructions for Poorgramer-Zack/dart-expert-skills, covering flutter skills repository - copilot instructions, repository overview, architecture, directory structure and skill structure.

Poorgramer-Zack/dart-expert-skills · 2,008 tokens