Skip to content

Commit 989827e

Browse files
committed
docs: clarify INITIAL-DESIGN, add F-Droid submission guide, update README links and rename UI file refs in TRANSLATION_FLOW
1 parent c92eb49 commit 989827e

3 files changed

Lines changed: 6 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,6 @@
5353

5454
# Documentation
5555
- **Design & Branding**: [docs/DESIGN.md](docs/DESIGN.md) - UI/UX strategy, branding, typography, and themes.
56-
- **Initial Design**: [docs/INITIAL-DESIGN.md](docs/INITIAL-DESIGN.md) - Original design manifest.
56+
- **Initial Design**: [docs/INITIAL-DESIGN.md](docs/INITIAL-DESIGN.md) - Technical design document and architecture.
5757
- **Translation Flow**: [docs/TRANSLATION_FLOW.md](docs/TRANSLATION_FLOW.md) - Technical flow of translation features.
58+
- **F-Droid Submission**: [docs/FDROID_SUBMISSION.md](docs/FDROID_SUBMISSION.md) - Guide for submitting to F-Droid.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ This is a standard Gradle project. To build it:
2525
* Codename: Janus
2626
* Application ID: `com.anysoftkeyboard.janus`
2727
* For a detailed breakdown of the technical design and architecture, see the `INITIAL-DESIGN.md` file.
28+
* For UI/UX strategy and branding, see the `DESIGN.md` file.
29+
* For the technical flow of translation features, see the `TRANSLATION_FLOW.md` file.
2830

2931
## License
3032
This project is licensed under the Apache License 2.0. See the `LICENSE` file for details.

docs/TRANSLATION_FLOW.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ val translationState = if (langTranslation == null) {
244244
```
245245

246246
### UI Behavior
247-
**File**: `app/src/main/java/com/anysoftkeyboard/janus/app/ui/states/TranslationContent.kt`
247+
**File**: `app/src/main/java/com/anysoftkeyboard/janus/app/ui/states/TranslationView.kt`
248248

249249
Displays Snackbar: "Translation to {targetLang} not found. Available translations: {langCodes}"
250250

@@ -404,7 +404,7 @@ try {
404404
```
405405

406406
### UI Display
407-
**File**: `app/src/main/java/com/anysoftkeyboard/janus/app/ui/states/ErrorView.kt`
407+
**File**: `app/src/main/java/com/anysoftkeyboard/janus/app/ui/states/EmptyState.kt`
408408

409409
Shows error type and message with retry button.
410410

0 commit comments

Comments
 (0)