docs(android): add architecture documentation#197
Merged
Conversation
Add per-component docs under webtrit_callkeep_android/docs/: - architecture.md -- master overview, component index, high-level diagram - dual-process.md -- process boundaries and IPC design - plugin.md -- WebtritCallkeepPlugin lifecycle - callkeep-core.md -- InProcessCallkeepCore facade - foreground-service.md -- ForegroundService Pigeon host and broadcast receiver - connection-tracker.md -- MainProcessConnectionTracker shadow registry - phone-connection-service.md -- PhoneConnectionService Telecom integration - phone-connection.md -- PhoneConnection individual call object - connection-manager.md -- ConnectionManager call registry - ipc-broadcasting.md -- cross-process event catalogue - background-services.md -- SignalingIsolateService, IncomingCallService, ActiveCallService - pigeon-apis.md -- all host and Flutter API definitions - models.md -- CallMetadata, CallHandle, AudioDevice and other data models - notifications.md -- notification builders and channel management - call-flows.md -- incoming, outgoing, teardown and hot-restart flows Update README.md to reference docs/, describe background modes, build commands, key invariants, and related packages.
Add docs/ pointer with links to key component docs in the coding guide. Add docs/ and integration tests pointer to AGENTS.md.
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
1 participant
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.
Summary
webtrit_callkeep_android/docs/with 15 per-component architecture documentsdocs/architecture.mdwith component index, high-level diagram, and key constraintsREADME.mdwith architecture overview, background modes, integration tests section, build commands, and key invariantsAGENTS.mdwith pointer todocs/and integration tests sectionCLAUDE.mdto use@importsyntax for auto-loading key docs into contextDocs added
architecture.mddual-process.mdplugin.mdWebtritCallkeepPluginlifecyclecallkeep-core.mdCallkeepCore/InProcessCallkeepCorefacadeforeground-service.mdForegroundServicePigeon host and broadcastsconnection-tracker.mdMainProcessConnectionTrackershadow registryphone-connection-service.mdPhoneConnectionServiceTelecom integrationphone-connection.mdPhoneConnectionindividual call objectconnection-manager.mdConnectionManagercall registryipc-broadcasting.mdbackground-services.mdSignalingIsolateService,IncomingCallService,ActiveCallServicepigeon-apis.mdmodels.mdCallMetadata,CallHandle,AudioDeviceand other modelsnotifications.mdcall-flows.mdTest plan
@importpaths inCLAUDE.mdpoint to existing files