doces: add AGENTS.md for better hinting LLM

AGENTS.md

@@ -0,0 +1,12 @@
+# AGENTS
+
+Always read `README.md` and `docs/meta-arch.md` when new chat created.
+
+Additionally read relevant files depends on task.
+
+* If want to modify use cases (files at `test/features/*.feature`)
+    * read `docs/FRs.md`
+* If want to modify code (implement or test) of `View` of MVVM (UI widget) (files at `lib/ui/features/*/widgets/*`)
+    * read `docs/wireframe.md`, `docs/NFRs.md`, `test/features/*.feature`
+* If want to modify code (implement or test) of non-View e.g. `Model`, `View Model`, services...
+    * read `test/features/*.feature`, `docs/NFRs.md`

README.md

@@ -12,17 +12,20 @@ checkout [`docs/FRs.md`](docs/FRs.md)
 # flutter clean
 # arb_translate
 flutter pub get
-# generate gherkin test
+# > to generate gherkin test
 flutter pub run build_runner build --delete-conflicting-outputs
+# > to remove unused step definitions
 # dart run tool/prune_unused_steps.dart --delete
+# > to static analyze the code
+flutter analyze
+# > run unit tests and widget tests
+flutter test
+
 # dart run tool/gen_view_wireframe_md.dart
 # flutter pub run dead_code_analyzer
 
 # run the app
 flutter run
-
-# run unit tests and widget tests
-flutter test
 ```
 
 ### build

docs/meta-arch.md

@@ -20,3 +20,5 @@ The repo structure follows official [Package structure](https://docs.flutter.dev
     * [How to zoom in PdfPageView #244](https://github.com/espresso3389/pdfrx/issues/244)
   * So does overlay some widgets, they should be placed using the provided overlay builder.
     * [Viewer Customization using Widget Overlay](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfViewerParams/viewerOverlayBuilder.html)
+    * [Per-page Customization using Widget Overlay](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfViewerParams/pageOverlaysBuilder.html)
+      * `pageOverlaysBuilder`