[GH-ISSUE #18] Prepare MVP documentation, contribution guidance and canonical wiki sources #17

New Issue

2026-10-23T18:09:17+02:00

jayanezj commented

2026-10-23 18:09:17 +02:00

Originally created by @jayanezj on GitHub (Oct 23, 2026).
Original GitHub issue: https://github.com/jayanezj/traccar-client-macos/issues/18

Goal

Make the MVP installable and understandable with reviewed public documentation, without exposing private planning material.

Scope

Prepare README, Apache-2.0 license, contribution/security guidance and the agreed issue/PR templates. Clearly identify the independent, unofficial client and review any reused material for licensing/attribution.
Write canonical wiki Markdown under docs/wiki/: introduction, installation, Gatekeeper authorization, receiver/identifier configuration, everyday use, privacy, diagnostics and development.
Provide README and installation/Gatekeeper/configuration guides in English and Spanish. Keep technical documentation in English and explain that issues/contributions can use English or Spanish, including translation contributions.
Explain local-only identifier generation and server-side registration responsibility, demo default without automatic transmission, HTTP acknowledgement, actual timestamp/accuracy semantics, queue limits/discards and manual SOS retry.
Document verified ad hoc signature limitations and manual DMG upgrades, preserving compatible settings/identity/queue. Include supported OS/architecture and test coverage without claiming GPS precision or sleep-time tracking.
Document PR-based wiki maintenance and later manual publication through the wiki Git repository with the maintainer's existing SSH signing policy. Publish neither the wiki nor private sources as part of local preparation.

Acceptance criteria

The installation/configuration paths match the packaged candidate and are usable in both agreed languages.
No guide instructs global Gatekeeper disabling or promises Developer ID/notarization.
No private receiver, identifier, credentials, machine-specific paths or unreviewed screenshots appear in public documents.
Canonical wiki sources and manual publication steps are ready for later authorized publication, with no competing web-edit source.
Future automatic updates and other post-MVP features are clearly separate from delivered functionality.

Validation

Review documentation against the candidate, check relative links and follow installation/configuration instructions using synthetic examples. Any future public repository/wiki links must be verified after creation; do not present guessed URLs as live resources.

Dependencies

Originally created by @jayanezj on GitHub (Oct 23, 2026). Original GitHub issue: https://github.com/jayanezj/traccar-client-macos/issues/18 ## Goal Make the MVP installable and understandable with reviewed public documentation, without exposing private planning material. ## Scope - Prepare README, Apache-2.0 license, contribution/security guidance and the agreed issue/PR templates. Clearly identify the independent, unofficial client and review any reused material for licensing/attribution. - Write canonical wiki Markdown under `docs/wiki/`: introduction, installation, Gatekeeper authorization, receiver/identifier configuration, everyday use, privacy, diagnostics and development. - Provide README and installation/Gatekeeper/configuration guides in English and Spanish. Keep technical documentation in English and explain that issues/contributions can use English or Spanish, including translation contributions. - Explain local-only identifier generation and server-side registration responsibility, demo default without automatic transmission, HTTP acknowledgement, actual timestamp/accuracy semantics, queue limits/discards and manual SOS retry. - Document verified ad hoc signature limitations and manual DMG upgrades, preserving compatible settings/identity/queue. Include supported OS/architecture and test coverage without claiming GPS precision or sleep-time tracking. - Document PR-based wiki maintenance and later manual publication through the wiki Git repository with the maintainer's existing SSH signing policy. Publish neither the wiki nor private `sources` as part of local preparation. ## Acceptance criteria - [ ] The installation/configuration paths match the packaged candidate and are usable in both agreed languages. - [ ] No guide instructs global Gatekeeper disabling or promises Developer ID/notarization. - [ ] No private receiver, identifier, credentials, machine-specific paths or unreviewed screenshots appear in public documents. - [ ] Canonical wiki sources and manual publication steps are ready for later authorized publication, with no competing web-edit source. - [ ] Future automatic updates and other post-MVP features are clearly separate from delivered functionality. ## Validation Review documentation against the candidate, check relative links and follow installation/configuration instructions using synthetic examples. Any future public repository/wiki links must be verified after creation; do not present guessed URLs as live resources. ## Dependencies - [PROTO-013](https://github.com/jayanezj/traccar-client-macos/issues/13) - [PROTO-016](https://github.com/jayanezj/traccar-client-macos/issues/16)

jayanezj added this to the M5 - Distribution and MVP acceptance milestone 2026-10-23 18:09:17 +02:00

jayanezj added the priority:normal area:distribution type:docs labels 2026-10-23 18:09:17 +02:00

jayanezj referenced this issue

2026-10-25 11:00:18 +01:00

[GH-ISSUE #3] Implement initial configuration and local identity persistence #2

jayanezj referenced this issue

2026-10-25 11:00:20 +01:00

[PR #24] [MERGED] Persist receiver configuration and device identity #24

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: jayanezj/traccar-client-macos#17