Mm 441 docs update

[Aryan-Baglane]

Fixes - MM-441 Documentation update for the feature/savingsapplication

Didn't create a Jira ticket, click here to create new.

Please Add Screenshots If there are any UI changes.

Before	After

Please make sure these boxes are checked before submitting your pull request - thanks!

• [ x] Run the static analysis check ./gradlew check or ci-prepush.sh to make sure you didn't break anything

• If you have multiple commits please combine them into one commit by squashing them.

Summary by CodeRabbit

• New Features
  • Added a complete savings account application flow enabling users to apply for savings accounts and fill out detailed application information.
  • Integrated navigation system with error handling and confirmation dialogs for a seamless application experience.

[coderabbitai]

Walkthrough

This pull request introduces navigation infrastructure and UI components for a new Savings Application feature. It adds a Koin dependency injection module, type-safe route definitions with navigation extensions for savings apply and fill application flows, navigation graph setup, and composable screen components for the savings application workflow.

Changes

Cohort / File(s)	Summary
Dependency Injection Setup feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/di/SavingsApplicationModule.kt	Introduces Koin module with viewModelOf registrations for SavingsApplyViewModel and SavingsFillApplicationViewModel.
Navigation Routes & Extensions (Savings Apply) feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyRoute.kt	Adds serializable SavingsApplyRoute data class, NavController.navigateToSavingsApplyScreen() extension, and NavGraphBuilder.savingsApplyDestination() builder for destination configuration.
Navigation Routes & Extensions (Fill Application) feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationRoute.kt	Adds SavingsFillApplicationRoute data class with product and field officer details, NavController.navigateToSavingsFillApplicationScreen() extension, and NavGraphBuilder.savingsFillApplicationDestination() builder.
Navigation Graph Setup feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/navigation/SavingsApplicationNavGraph.kt	Introduces NavController.navigateToSavingsApplicationGraph() and NavGraphBuilder.savingsApplicationNavGraph() with wiring for nested destinations and status screen callback.
UI Screen Components (Savings Apply) feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyScreen.kt	Adds SavingsApplyScreen composable orchestrating ViewModel state/events, SavingsAccountDialog for error/unsaved changes dialogs, and SavingsAccountContent stateless UI renderer.
UI Documentation (Fill Application) feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationScreen.kt	Adds comprehensive KDoc comments for SavingsFillApplicationScreen, SavingsFillApplicationDialog, and SavingsFillApplicationContent composables.

Sequence Diagram

sequenceDiagram
    participant Nav as Navigation
    participant SAG as SavingsApplicationGraph
    participant SAA as SavingsApply
    participant FAL as FillApplication
    participant VM as ViewModel
    participant UI as Composable

    Nav->>SAG: navigateToSavingsApplicationGraph()
    SAG->>SAA: Register savingsApplyDestination
    SAA->>UI: Compose SavingsApplyScreen
    UI->>VM: Observe state & events
    VM-->>UI: Emit SavingsApplicationState
    UI->>UI: Render SavingsAccountContent
    Note over UI: User selects product
    UI->>Nav: navigateToSavingsFillApplicationScreen<br/>(productId, officerId, officerName)
    Nav->>SAG: Route to fillApplication
    SAG->>FAL: Register savingsFillApplicationDestination
    FAL->>UI: Compose SavingsFillApplicationScreen
    UI->>VM: Handle fill application flow
    Note over UI,VM: Form submission & navigation

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

• Navigation wiring consistency: Verify that all route objects follow serialization patterns and navigation extension functions pass correct parameters across the savings apply and fill application destinations.
• ViewModel state management: Review SavingsApplyScreen and SavingsFillApplicationScreen composables for proper state observation, event handling, and callback wiring to ensure no missing navigation hooks.
• Dependency injection scope: Confirm that SavingsApplicationModule correctly registers ViewModels and any transitive dependencies are properly wired in the DI graph.
• Navigation graph composition: Ensure savingsApplicationNavGraph correctly delegates to nested destinations and that callback signatures (especially navigateToStatusScreen with five String parameters) align across all callers.

Suggested reviewers

• Nagarjuna0033
• WizCoderr

Poem

🐰 A rabbit hops through routes so neat,
ViewModel states and UI so sweet,
Fill forms, apply, navigate with grace,
Savings flows now find their place! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Mm 441 docs update' is vague and generic, using non-descriptive terminology that doesn't convey meaningful information about the actual changes in the PR.	Provide a more descriptive title that clearly summarizes the main changes, such as 'Add navigation and DI wiring for savings application feature' or 'Implement savings application navigation graph and Koin module'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	Docstring coverage is 80.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 768a6a6 and 4b8ecb8.

📒 Files selected for processing (6)

• feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/di/SavingsApplicationModule.kt (1 hunks)
• feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationRoute.kt (2 hunks)
• feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationScreen.kt (3 hunks)
• feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/navigation/SavingsApplicationNavGraph.kt (1 hunks)
• feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyRoute.kt (1 hunks)
• feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyScreen.kt (3 hunks)

🔇 Additional comments (16)

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationScreen.kt (3)

66-76: Excellent documentation for the screen entry point.

The KDoc clearly describes the composable's role, state management, event handling, and navigation responsibilities. Parameter documentation is comprehensive and accurate.

---

120-129: Well-documented dialog composable.

The documentation accurately describes the dialog presentation logic and parameter responsibilities. Clear and concise.

---

159-168: Clear documentation for the content composable.

The KDoc effectively describes the stateless nature of the composable and its UI state handling. Well done.

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/di/SavingsApplicationModule.kt (1)

17-33: Well-documented DI module.

The module-level documentation clearly explains the purpose of the Koin module, and each ViewModel registration includes a helpful description of its role in the savings application flow.

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyScreen.kt (3)

54-65: Comprehensive documentation for the apply screen entry point.

The KDoc effectively describes the screen's purpose, state management, and navigation orchestration. Parameter descriptions are clear and accurate.

---

102-110: Clear dialog documentation.

The documentation accurately describes the dialog presentation responsibilities and follows the same pattern as the Fill Application screen for consistency.

---

138-147: Well-documented content composable.

The KDoc clearly explains the stateless UI rendering behavior and conditional display logic based on screen state.

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyRoute.kt (3)

18-24: Clear route documentation.

The KDoc succinctly describes the route's purpose as the entry point for the savings application flow.

---

26-37: Well-documented navigation extension.

The documentation clearly explains the convenience function's purpose and its parameter.

---

39-60: Comprehensive destination builder documentation.

The KDoc effectively describes the destination setup, screen wiring, and navigation callbacks. Parameter documentation is complete and accurate.

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/navigation/SavingsApplicationNavGraph.kt (3)

22-27: Clear graph route documentation.

The KDoc concisely describes the navigation graph route object's purpose.

---

29-39: Well-documented navigation convenience function.

The documentation clearly explains the extension function's purpose and encapsulation benefit.

---

41-73: Comprehensive graph builder documentation.

The KDoc effectively describes the nested navigation graph construction, destination wiring, and the decoupled architecture approach. Parameter documentation is thorough and helps understand the navigation flow.

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationRoute.kt (3)

20-35: Comprehensive route documentation.

The KDoc clearly describes the route's purpose and includes detailed property documentation for all parameters. Well done.

---

37-56: Well-documented navigation extension.

The documentation effectively explains the convenience function and provides clear parameter descriptions.

---

58-83: Thorough destination builder documentation.

The KDoc comprehensively describes the destination setup, screen wiring, and navigation callback responsibilities. All parameters are well documented.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[biplab1]

Please add Jira ticket like this: Fixes - [Jira-#441](https://mifosforge.jira.com/browse/MM-441)

So that it shows up as this: Fixes - Jira-#441 and can be tracked in Jira Kanban board.

[biplab1]

Every time you write a PR title or commit message, please refer to one of the following documents. After some time you will be able to do it without looking at these docs.

• For writing better commit message or PR titles: https://github.com/openMF/mobile-wallet/wiki/Commit-style-guide
• For more details: https://www.conventionalcommits.org/en/v1.0.0/