website icon indicating copy to clipboard operation
website copied to clipboard

Docs, guides, and best practices, could be output in the form of AI rules

Open CillianMyles opened this issue 5 months ago • 4 comments

What information needs to be added?

The content on docs.flutter.dev, and subpages, contain a wealth of information oh how best to create good Flutter apps and Dart code.

The community repo https://github.com/evanca/flutter-ai-rules is a great starting point for Flutter developers who want to add some rules for AI-based Flutter development, however I feel like the docs site itself obviously contains more information, and is kept up to date with new developments.

It would be perfect, in my opinion, if there was some way that the docs (or selected docs) from the docs website could be output into a format already directly consumable by the AI dev tools e.g. .cursor/rules/*.mdc.

Making it easy for Flutter apps to include these rules means the Flutter code output by these tools should be of higher quality.

Where should this new content appear?

An easy way for Flutter developers to pull in the docs/guides/rules they want into their projects would be ideal.

Some ideas I have:

  • optional part of Flutter create command/CLI
  • script that can be run to pull in the latest docs/guides/rules from this repo into a Flutter project (interactive would be best so devs can pick and choose what they want)
  • a folder in this repo could be dedicated to AI docs/guides/rules, and users could pull those in manually, or add this repo as a submodule and symlink to the rules they care about
  • create a new repo for these rules, or simply extend https://github.com/evanca/flutter-ai-rules, and make it the single source of truth

I would like to fix this problem.

  • [ ] I will try and fix this problem on docs.flutter.dev.

CillianMyles avatar Jul 23 '25 09:07 CillianMyles

cc/ @evanca @sethladd

CillianMyles avatar Jul 23 '25 10:07 CillianMyles

I’m totally happy for my repo to be used, extended, or merged into an official source of truth for AI-based Flutter rules. Let me know how I can support if this evolves.

evanca avatar Jul 23 '25 10:07 evanca

@srcnysf sounds like you might be interested as well! :)

esrakadah avatar Jul 31 '25 18:07 esrakadah

Yes I already put some cursor rules/prompts for Flutter on https://cursor.directory/ a while ago and use them on current projects. So I can contribute :)

srcnysf avatar Jul 31 '25 18:07 srcnysf