Skip to content

docs: bring the docs in line with the code - #44

Merged
InftyAI-Agent merged 4 commits into
mainfrom
chore/cleanup-docs
Oct 17, 2026
Merged

InftyAI-Agent merged 4 commits into
mainfrom
chore/cleanup-docs

Conversation

@kerthcet

Copy link
Copy Markdown
Member
  • DEVELOP.md: fix the project layout (protocol/ crate, python.rs, snapshot/), drop references to files that do not exist (test_build.sh, simple_test.py, agent_example.py, protocol.rs, STATUS.md), and document the real make targets, test markers and release flow.
  • QUICKSTART.md: use make targets, and list_daemons() returning DaemonInfo.
  • ARCHITECTURE.md: stop claiming daemons authenticate; describe the planned Keycloak-based auth instead.
  • README.md: file upload is not implemented on the daemon; list snapshots and labels/broadcast; add auth and file upload to the roadmap.
  • PROTOCOL.md: point at protocol/src/lib.rs.

What this PR does / why we need it

Which issue(s) this PR fixes

Fixes #

Special notes for your reviewer

Does this PR introduce a user-facing change?


Copilot AI balanced review requested due to automatic review settings October 17, 2026 10:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

@coderabbitai

coderabbitai Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b5d2b482-3cde-431a-aa5d-4de9af05a220
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@InftyAI-Agent InftyAI-Agent added needs-triage Indicates an issue or PR lacks a label and requires one. needs-priority Indicates a PR lacks a label and requires one. do-not-merge/needs-kind Indicates a PR lacks a label and requires one. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 17, 2026
@kerthcet

Copy link
Copy Markdown
Member Author

/lgtm
/kind cleanup

@InftyAI-Agent InftyAI-Agent added lgtm Looks good to me, indicates that a PR is ready to be merged. cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. and removed do-not-merge/needs-kind Indicates a PR lacks a label and requires one. labels Oct 17, 2026
@kerthcet

Copy link
Copy Markdown
Member Author

/hold

@InftyAI-Agent InftyAI-Agent added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. and removed lgtm Looks good to me, indicates that a PR is ready to be merged. labels Oct 17, 2026
@kerthcet

Copy link
Copy Markdown
Member Author

/lgtm
/unhold

@InftyAI-Agent InftyAI-Agent added lgtm Looks good to me, indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Oct 17, 2026
InftyAI-Agent pushed a commit that referenced this pull request Oct 17, 2026
The daemon handles each message inline, so while a command runs its serve
loop reads nothing and the controller's heartbeat acks sit unread in the
socket. When the command finished, the next ack_check saw no ack for longer
than ack_timeout (30s by default) and reconnected, so the daemon vanished
from the registry for its 5s backoff right after answering.

This broke the E2E run on #44: `microdnf install -y curl` on rocky took
the full 60s timeout, daemon-rocky-1 reconnected the same instant, and the
following tests failed with "Daemon daemon-rocky-1 not found".

Restart the ack deadline after each inline message. The buffered acks are
read on the next iterations; a controller that really stopped acking is
still caught one ack_timeout later. Introduced in #40.

Signed-off-by: kerthcet <kerthcet@gmail.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
kerthcet and others added 4 commits October 17, 2026 20:21
- DEVELOP.md: fix the project layout (protocol/ crate, python.rs, snapshot/),
  drop references to files that do not exist (test_build.sh, simple_test.py,
  agent_example.py, protocol.rs, STATUS.md), and document the real make
  targets, test markers and release flow.
- QUICKSTART.md: use make targets, and list_daemons() returning DaemonInfo.
- ARCHITECTURE.md: stop claiming daemons authenticate; describe the planned
  Keycloak-based auth instead.
- README.md: file upload is not implemented on the daemon; list snapshots and
  labels/broadcast; add auth and file upload to the roadmap.
- PROTOCOL.md: point at protocol/src/lib.rs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: kerthcet <kerthcet@gmail.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: kerthcet <kerthcet@gmail.com>
State plainly that daemons are not authenticated yet, what direct and
tunnel mode do and do not protect, and that the tunnel authkey is a
Headscale key rather than a SandD credential.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: kerthcet <kerthcet@gmail.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: kerthcet <kerthcet@gmail.com>
@InftyAI-Agent InftyAI-Agent removed the lgtm Looks good to me, indicates that a PR is ready to be merged. label Oct 17, 2026
@kerthcet

Copy link
Copy Markdown
Member Author

/lgtm

@InftyAI-Agent InftyAI-Agent added the lgtm Looks good to me, indicates that a PR is ready to be merged. label Oct 17, 2026

@InftyAI-Agent InftyAI-Agent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved: PR has both lgtm and approved labels

@InftyAI-Agent
InftyAI-Agent merged commit 1e8545b into main Oct 17, 2026
20 checks passed
@kerthcet
kerthcet deleted the chore/cleanup-docs branch October 17, 2026 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Looks good to me, indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a label and requires one. needs-triage Indicates an issue or PR lacks a label and requires one.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants