Context
The main dart_monty README has large sections on DefaultMontyBridge, HostFunction, HostFunctionSchema, MontyPlugin, and PluginRegistry. A newbie reads the README and tries to import these.
Steps to reproduce
dart create myapp && cd myapp
dart pub add dart_monty
Write code from the README:
import 'package:dart_monty_bridge/dart_monty_bridge.dart';
final bridge = DefaultMontyBridge(platform: Monty());
Expected
It works — the README taught me to use it.
Actual
Could not resolve the package 'dart_monty_bridge'
Must separately run:
dart pub add dart_monty_bridge
Impact
- Newbie: "I followed the README and it doesn't work. Is it broken?"
- LLM: Generates import statements that fail, then has to debug missing packages
- Intermediate: Will figure it out, but it's unnecessary friction
Suggested fix
Add a clear note before the Bridge section:
> **Note:** The bridge API requires a separate package:
> ```
> dart pub add dart_monty_bridge
> ```
Or consider re-exporting bridge types from dart_monty directly, since the README presents them as core functionality.
Context
The main
dart_montyREADME has large sections onDefaultMontyBridge,HostFunction,HostFunctionSchema,MontyPlugin, andPluginRegistry. A newbie reads the README and tries to import these.Steps to reproduce
Write code from the README:
Expected
It works — the README taught me to use it.
Actual
Must separately run:
Impact
Suggested fix
Add a clear note before the Bridge section:
Or consider re-exporting bridge types from
dart_montydirectly, since the README presents them as core functionality.