Skip to content

docs: sync markdown and KDocs with current source code#443

Merged
hossain-khan merged 2 commits into
mainfrom
copilot/update-markdown-and-source-code-docs
Apr 25, 2026
Merged

docs: sync markdown and KDocs with current source code#443
hossain-khan merged 2 commits into
mainfrom
copilot/update-markdown-and-source-code-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 25, 2026

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)

  • Kotlin 2.2.02.3.20
  • Room 2.7.12.8.4
  • OkHttp 4.12.05.3.2
  • WorkManager 2.10.12.11.2
  • DataStore 1.1.61.2.1

Circuit / Metro pattern corrections (copilot-instructions.md + developer-portal README)

  • Event type: sealed class Event : CircuitUiEventsealed interface Event : CircuitUiEvent
  • Presenter injection: @Inject class SettingsPresenter@AssistedInject class SettingsPresenter
  • TestNotificationChannel parameter: notifierTypechannelType

Developer Portal State types (developer-portal README)

Corrected the State data class to match actual types:

// Before (wrong)
val currentStorageGb: Double,
val maxStorageGb: Int,

// After (correct)
val currentStorageGb: Long,
val maxStorageGb: Long,

Missing Discord coverage

Added Discord to Key Features, Project Overview, and notification methods in copilot-instructions.md and app-description.md (added in v1.16, absent from all docs).

Release checklist (release-notes.md)

  • build.gradleapp/build.gradle.kts
  • Replaced outdated "Firebase Test Lab APK upload" steps with the current local-build-and-upload process

Source code KDocs

Added class-level and method-level KDocs to undocumented business-logic classes:

  • BatteryMonitor — sticky broadcast approach, all 3 methods
  • StorageMonitor — both measurement strategies, preferred path called out, all 4 methods
  • AlertMediumConfigStore — interface contract + hasValidConfig() / validateConfig() methods
  • AlertMediumConfig.TwilioConfig / EmailConfig — all fields documented
  • AlertMediumConfig.WebhookConfig — clarified shared use by REST and Slack senders

Cleanup

  • Fixed "each devices""each device" typo in app-description.md
  • Removed phase3-implementation-plan.md (implementation completed, file was orphaned)

- 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
Copilot AI requested a review from hossain-khan April 25, 2026 14:57
@hossain-khan hossain-khan marked this pull request as ready for review April 25, 2026 15:33
@github-actions
Copy link
Copy Markdown

Code Coverage Report

View Coverage Report

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 36.16%. Comparing base (a9ee8b2) to head (ed005d0).

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Copy Markdown

📊 APK Size Analysis

Comparing maincopilot/update-markdown-and-source-code-docs (this PR)

OLD: base.apk (signature: V2)
NEW: app-release.apk (signature: V2)

          │          compressed          │         uncompressed         
          ├───────────┬───────────┬──────┼───────────┬───────────┬──────
 APK      │ old       │ new       │ diff │ old       │ new       │ diff 
──────────┼───────────┼───────────┼──────┼───────────┼───────────┼──────
      dex │   6.7 MiB │   6.7 MiB │  0 B │   6.7 MiB │   6.7 MiB │  0 B 
     arsc │ 370.7 KiB │ 370.7 KiB │  0 B │ 370.6 KiB │ 370.6 KiB │  0 B 
 manifest │   3.7 KiB │   3.7 KiB │  0 B │  16.8 KiB │  16.8 KiB │  0 B 
      res │ 126.1 KiB │ 126.1 KiB │  0 B │ 168.3 KiB │ 168.3 KiB │  0 B 
   native │  64.3 KiB │  64.3 KiB │  0 B │    63 KiB │    63 KiB │  0 B 
    asset │  55.4 KiB │  55.4 KiB │  0 B │ 143.2 KiB │ 143.2 KiB │  0 B 
    other │  74.6 KiB │  74.6 KiB │ -1 B │ 154.9 KiB │ 154.9 KiB │  0 B 
──────────┼───────────┼───────────┼──────┼───────────┼───────────┼──────
    total │   7.4 MiB │   7.4 MiB │ -1 B │   7.6 MiB │   7.6 MiB │  0 B 

 DEX     │ old   │ new   │ diff      
─────────┼───────┼───────┼───────────
   files │     1 │     1 │ 0         
 strings │ 34044 │ 34044 │ 0 (+4 -4) 
   types │  9115 │  9115 │ 0 (+0 -0) 
 classes │  7750 │  7750 │ 0 (+0 -0) 
 methods │ 43362 │ 43362 │ 0 (+0 -0) 
  fields │ 26011 │ 26011 │ 0 (+0 -0) 

 ARSC    │ old │ new │ diff 
─────────┼─────┼─────┼──────
 configs │ 105 │ 105 │  0   
 entries │ 273 │ 273 │  0
APK
  compressed  │ uncompressed │                                           
───────┬──────┼───────┬──────┤                                           
 size  │ diff │ size  │ diff │ path                                      
───────┼──────┼───────┼──────┼───────────────────────────────────────────
 271 B │ -1 B │ 120 B │  0 B │ ∆ META-INF/version-control-info.textproto 
───────┼──────┼───────┼──────┼───────────────────────────────────────────
 271 B │ -1 B │ 120 B │  0 B │ (total)
DEX
STRINGS:

   old   │ new   │ diff      
  ───────┼───────┼───────────
   34044 │ 34044 │ 0 (+4 -4) 
  
  + ed005d0
  + r8-map-id-0570375ba03712f72556d1cc2a355b8f596b0ac82bdb2d466e68322a75aa1530
  + v1.20 (ed005d0)
  + ~~R8{"backend":"dex","compilation-mode":"release","has-checksums":false,"min-api":30,"pg-map-id":"0570375ba03712f72556d1cc2a355b8f596b0ac82bdb2d466e68322a75aa1530","r8-mode":"full","version":"9.1.31"}
  
  - a9ee8b2
  - r8-map-id-04158f7f96ee96da07a08a40152abbe568d59a8bea02e0bb2caffe289ac1ae59
  - v1.20 (a9ee8b2)
  - ~~R8{"backend":"dex","compilation-mode":"release","has-checksums":false,"min-api":30,"pg-map-id":"04158f7f96ee96da07a08a40152abbe568d59a8bea02e0bb2caffe289ac1ae59","r8-mode":"full","version":"9.1.31"}

Generated by Diffuse via diffuse-action

@hossain-khan hossain-khan merged commit a0c0cf8 into main Apr 25, 2026
4 checks passed
@hossain-khan hossain-khan deleted the copilot/update-markdown-and-source-code-docs branch April 25, 2026 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Analyze all the markdown docs and source-code docs for freshness and update if necessary

3 participants