rule-flutter-flutter-documentation-contracts-always-on

Enforce Flutter documentation updates before code merges.

Updated Nov 7, 2025
One-click install
npx skills add https://github.com/belluga/delphi-ai --skill rule-flutter-flutter-documentation-contracts-always-on
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rule-flutter-flutter-documentation-contracts-always-on
Source: https://github.com/belluga/delphi-ai/tree/main/.cline/skills/rule-flutter-flutter-documentation-contracts-always-on
Command: npx skills add https://github.com/belluga/delphi-ai --skill rule-flutter-flutter-documentation-contracts-always-on

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When Flutter changes occur, this rule prevents drift by requiring up-to-date foundation documentation before merges, ensuring teams align on contracts and UI flows.

Core Features & Use Cases

  • Enforces documentation updates for screen/flow changes in foundation_documentation/screens/*.md and DTO references in modules.
  • Tracks prototype data and domain vocab changes in foundation_documentation/domain_entities.md and related sections.
  • Ensures affected modules and system roadmaps reflect the new scope prior to code implementation.
  • Use Case: A Flutter change in a prototype triggers mandatory doc updates across screens, DTOs, and roadmap references to avoid integration surprises.

Quick Start

Review Flutter change PRs to verify corresponding foundation_documentation updates exist and update them if missing.

Frequently Asked Questions about rule-flutter-flutter-documentation-contracts-always-on

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce documentation updates for Flutter changes before merging code?

To enforce documentation updates for Flutter changes before code merges, this rule checks that foundation_documentation files, including screens and domain_entities, are updated alongside the PR. It prevents documentation drift by verifying DTO references and system roadmaps reflect the new scope.

Why does my Flutter project have documentation drift between code and mocks?

Documentation drift between code and mocks occurs when Flutter changes merge without synchronized updates to foundation_documentation. This rule prevents drift by requiring up-to-date screen, domain entity, and DTO reference docs before code merges, ensuring alignment on contracts and UI flows.

What foundation documentation files need updates when modifying Flutter screens?

When modifying Flutter screens, foundation documentation files requiring updates include foundation_documentation/screens/*.md for UI flows, foundation_documentation/domain_entities.md for prototype data, module docs for DTO references, and foundation_documentation/system_roadmap.md for scope tracking.

Can I use this documentation governance rule for non-Flutter projects?

This documentation governance rule is specifically designed for Flutter projects requiring synchronization between code, mocks, and documentation. It applies to foundation_documentation structures, screen flows, and DTO references unique to Flutter development workflows.

How to verify foundation documentation exists for a Flutter change PR?

To verify foundation documentation for a Flutter change PR, review the PR to confirm corresponding foundation_documentation updates exist across screens, domain_entities, module docs, and system_roadmap. Update any missing documentation before proceeding with the code merge.

When do I need to update domain_entities.md and system_roadmap.md in Flutter projects?

You need to update domain_entities.md and system_roadmap.md in Flutter projects whenever prototype data, domain vocabulary, or project scope changes occur. This rule ensures these foundation documentation files reflect new scope prior to code implementation to avoid integration surprises.