Skip to content

Update README to reflect official rigctl/Hamlib support and Mermaid architecture - #170

Merged
xylo04 merged 6 commits into
mainfrom
copilot/update-readme-hamlib-support
Jun 30, 2026
Merged

Update README to reflect official rigctl/Hamlib support and Mermaid architecture#170
xylo04 merged 6 commits into
mainfrom
copilot/update-readme-hamlib-support

Conversation

Copilot AI commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

README still described rig control as “planned” despite Hamlib-backed rigctl support being available, and the architecture was rendered from a static diagram asset. This updates the docs to match current capabilities and switches the architecture representation to Mermaid for in-repo readability/editability.

  • Support status update

    • Replaced outdated wording that listed rigctld as pending.
    • Clarified current state: WSJT-X is supported and rig control via rigctl/Hamlib is officially supported; Ham Radio Deluxe remains planned.
  • Architecture diagram migration

    • Replaced ![Architecture](architecture.svg) with an inline Mermaid flowchart.
    • Kept the same topology and links while aligning labels with current terminology (rigctl/Hamlib).
  • Documentation consistency

    • Synchronized feature language and diagram labels so architecture and capability statements no longer diverge.
```mermaid
flowchart LR
    Application ---|websocket| agent
    agent ---|UDP| WSJTX
    agent ---|lib| rigctld[rigctl/Hamlib]

@xylo04

xylo04 commented Jun 30, 2026

Copy link
Copy Markdown
Member

@copilot

  • Rebase on main, I thought I had already merged those changes but hadn't
  • In the mermaid diagram, make sure the kel-agent node is highlighted.

Copilot AI added 2 commits June 30, 2026 15:49
* Initial plan

* docs: clarify kel-agent is a protocol bridge, not an AI agent

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Copilot AI commented Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

@copilot

  • Rebase on main, I thought I had already merged those changes but hadn't
  • In the mermaid diagram, make sure the kel-agent node is highlighted.

Done. The branch has been rebased onto the latest main, and the Mermaid diagram now highlights the kel-agent node in commit 567a998.

Copilot AI requested a review from xylo04 June 30, 2026 15:50
@xylo04
xylo04 marked this pull request as ready for review June 30, 2026 15:50
@xylo04

xylo04 commented Jun 30, 2026

Copy link
Copy Markdown
Member

@copilot resolve the merge conflicts in this pull request

* Initial plan

* docs: clarify kel-agent is a protocol bridge, not an AI agent

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Copilot AI commented Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

@copilot resolve the merge conflicts in this pull request

Resolved. I rebased and fixed the README conflict(s); the branch is now conflict-free in commit b9f4fbd.

@xylo04
xylo04 merged commit 3049f5f into main Jun 30, 2026
2 checks passed
@xylo04
xylo04 deleted the copilot/update-readme-hamlib-support branch June 30, 2026 15:58
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.

2 participants