docs: sync markdown and KDocs with current source code#443
Merged
Conversation
- Update library versions in copilot-instructions.md: - Kotlin 2.2.0 → 2.3.20 - Room 2.7.1 → 2.8.4 - OkHttp 4.12.0 → 5.3.2 - WorkManager 2.10.1 → 2.11.2 - DataStore 1.1.6 → 1.2.1 - Add Discord to Key Features and Project Overview in copilot-instructions.md - Fix Circuit Event pattern (sealed class → sealed interface) in copilot-instructions.md - Fix presenter example (@Inject → @AssistedInject) in copilot-instructions.md - Fix State data class types in developer-portal README (currentStorageGb/maxStorageGb: Double/Int → Long/Long) - Fix Event sealed interface in developer-portal README - Fix TestNotificationChannel parameter name in developer-portal README - Fix DI code sample format in developer-portal README - Update release-notes.md checklist (build.gradle → app/build.gradle.kts, replace outdated APK test/upload steps) - Add KDocs to BatteryMonitor (class + methods) - Add KDocs to StorageMonitor (class + methods) - Improve AlertMediumConfigStore interface documentation - Add missing KDocs to TwilioConfig and EmailConfig in AlertMediumConfig - Improve WebhookConfig KDoc to clarify Slack usage - Fix typo in app-description.md ("each devices" → "each device") - Add Discord to app-description.md notification methods - Remove obsolete phase3-implementation-plan.md Agent-Logs-Url: https://github.com/hossain-khan/android-remote-notify/sessions/380751c6-d162-4305-af99-6bb26b9d32a3 Co-authored-by: hossain-khan <99822+hossain-khan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Analyze and update documentation for markdown and source code
docs: sync markdown and KDocs with current source code
Apr 25, 2026
hossain-khan
approved these changes
Apr 25, 2026
Code Coverage Report |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #443 +/- ##
=======================================
Coverage 36.16% 36.16%
=======================================
Files 86 86
Lines 2527 2527
Branches 215 215
=======================================
Hits 914 914
Misses 1574 1574
Partials 39 39 🚀 New features to boost your workflow:
|
📊 APK Size AnalysisComparing APKDEXGenerated by Diffuse via diffuse-action |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several markdown docs and source-code KDocs had drifted from the actual codebase — stale library versions, missing Discord support, incorrect type signatures, and wrong Circuit/Metro patterns.
Library versions (copilot-instructions.md)
2.2.0→2.3.202.7.1→2.8.44.12.0→5.3.22.10.1→2.11.21.1.6→1.2.1Circuit / Metro pattern corrections (copilot-instructions.md + developer-portal README)
sealed class Event : CircuitUiEvent→sealed interface Event : CircuitUiEvent@Inject class SettingsPresenter→@AssistedInject class SettingsPresenterTestNotificationChannelparameter:notifierType→channelTypeDeveloper Portal State types (developer-portal README)
Corrected the
Statedata class to match actual types:Missing Discord coverage
Added Discord to Key Features, Project Overview, and notification methods in
copilot-instructions.mdandapp-description.md(added in v1.16, absent from all docs).Release checklist (release-notes.md)
build.gradle→app/build.gradle.ktsSource code KDocs
Added class-level and method-level KDocs to undocumented business-logic classes:
BatteryMonitor— sticky broadcast approach, all 3 methodsStorageMonitor— both measurement strategies, preferred path called out, all 4 methodsAlertMediumConfigStore— interface contract +hasValidConfig()/validateConfig()methodsAlertMediumConfig.TwilioConfig/EmailConfig— all fields documentedAlertMediumConfig.WebhookConfig— clarified shared use by REST and Slack sendersCleanup
"each devices"→"each device"typo inapp-description.mdphase3-implementation-plan.md(implementation completed, file was orphaned)