Skip to content

Add Pyxis user manual#17

Open
brothercorvo wants to merge 2 commits into
torlando-tech:feature/map-telemetryfrom
brothercorvo:codex/user-manual
Open

Add Pyxis user manual#17
brothercorvo wants to merge 2 commits into
torlando-tech:feature/map-telemetryfrom
brothercorvo:codex/user-manual

Conversation

@brothercorvo

Copy link
Copy Markdown

Summary

  • add a user manual covering installation, controls, screens, settings, and troubleshooting
  • document current runtime behavior and known limitations based on the firmware code
  • link the new manual from the README

Testing

  • not run (documentation only)

@greptile-apps

greptile-apps Bot commented Mar 15, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds a user manual (docs/user-manual.md) and links it from README.md. All documented values were verified against the firmware source (main.cpp, SettingsScreen.cpp, ChatScreen.cpp) and are accurate. One P2 style suggestion was left regarding the version-specific (0.2) parenthetical in the controls section.

Confidence Score: 5/5

Safe to merge — documentation-only change with no code modifications.

No P0 or P1 findings. The single P2 comment is a style nit on a version qualifier. All factual claims in the manual were verified against the firmware source and are accurate.

No files require special attention.

Important Files Changed

Filename Overview
README.md Adds a Documentation section with a link to the new user manual; one-line change, no issues.
docs/user-manual.md New 417-line user manual; content verified against firmware source for TCP defaults, LoRa options, timeout values, interval units, delivery indicators, and location-sharing options — all accurate. One version-specific parenthetical ("(0.2)") in the controls section is a minor style issue.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User opens Pyxis] --> B[Conversations Screen]
    B --> C[Tap conversation]
    B --> D[Compose button]
    B --> E[Announces button]
    B --> F[Status button]
    B --> G[Map button]
    B --> H[Settings button]

    C --> I[Chat Screen]
    I --> J[Send message]
    I --> K[GPS / Location sharing]
    I --> L[LXST Voice Call]

    D --> M[New Message Screen]
    E --> N[Announce List Screen]
    F --> O[Status Screen]
    O --> P[QR Share Screen]
    G --> Q[Map Screen]
    H --> R[Settings Screen]
    R --> S[Propagation Nodes Screen]
Loading
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
docs/user-manual.md:78
The parenthetical `(0.2)` ties these behaviors to a specific firmware version, which will read as confusing or stale for anyone on a different version. The behaviors themselves (long-press to delete/copy/paste) are general UI interactions that apply to the current build, so the version qualifier can simply be removed.

```suggestion
Useful behaviors:
```

Reviews (2): Last reviewed commit: "Update user manual map instructions" | Re-trigger Greptile

Comment thread docs/user-manual.md Outdated
Comment thread docs/user-manual.md Outdated
Comment thread docs/user-manual.md Outdated
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.

1 participant