Skip to content

Commit e502787

Browse files
[618] Update AGENTS.md to correct build types count and standardize file names in documentation
1 parent f6227f1 commit e502787

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

AGENTS.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ Android project template generator using [Nimble Compass](https://nimblehq.co/co
2323
/scripts → Generator script (new_project.kts)
2424
/template-compose → Source template (see its AGENTS.md for Android guidance)
2525
/sample-compose → Example output (regenerate, don't edit directly)
26-
/build-logic → Shared Gradle convention plugins
2726
/.github → CI workflows and PR templates
2827
```
2928

@@ -81,7 +80,7 @@ cd scripts && kscript new_project.kts package-name=co.test.app app-name="Test Ap
8180

8281
| File | Purpose |
8382
|------|---------|
84-
| `template-compose/config/detekt/detekt.yml` | Detekt rules |
83+
| `template-compose/detekt-config.yml` | Detekt rules |
8584
| `.github/workflows/run_detekt_and_unit_tests.yml` | CI pipeline (Detekt + unit tests) |
8685
| `.github/workflows/review_pull_request.yml` | PR automation and checks |
8786
| `.github/workflows/verify_newproject_script.yml` | Validate generator script on PRs |

template-compose/AGENTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ This project follows Google's official architecture guidance with a layered, mod
6666

6767
## Build Variants
6868

69-
The app has two product flavors and two build types:
69+
The app has two product flavors and three build types:
7070

7171
| Flavor | Purpose |
7272
|--------|---------|
@@ -138,16 +138,16 @@ fun `When user taps login, it shows loading`() { }
138138
| File | Purpose |
139139
|------|---------|
140140
| `app/.../MainActivity.kt` | Single activity entry point |
141-
| `app/.../ui/AppNavigation.kt` | Navigation graph |
141+
| `app/.../ui/AppNavGraph.kt` | Navigation graph |
142142
| `app/.../ui/base/BaseViewModel.kt` | ViewModel base class |
143143
| `data/.../remote/services/` | API service definitions |
144-
| `config/detekt/detekt.yml` | Detekt rules |
144+
| `detekt-config.yml` | Detekt rules |
145145

146146
## Configuration Files
147147

148148
| File | Purpose |
149149
|------|---------|
150-
| `config/detekt/detekt.yml` | Static analysis rules |
150+
| `detekt-config.yml` | Static analysis rules |
151151
| `app/proguard-rules.pro` | ProGuard configuration |
152152
| `local.properties` | API keys (gitignored) |
153153

0 commit comments

Comments
 (0)