Skip to content

docs: remove local-dev.md, consolidate into running-agents-locally#2179

Merged
rh-hemartin merged 1 commit into
mainfrom
fix/762-local-dev
Jun 15, 2026
Merged

docs: remove local-dev.md, consolidate into running-agents-locally#2179
rh-hemartin merged 1 commit into
mainfrom
fix/762-local-dev

Conversation

@rh-hemartin

Copy link
Copy Markdown
Member

Summary

  • Removes docs/guides/dev/local-dev.md, which duplicated most of running-agents-locally.md
  • Moves the "build from source" step (make go-build) to CONTRIBUTING.md
  • Updates all inbound links to point to running-agents-locally.md or CONTRIBUTING.md
  • Fixes a pre-existing broken link (-inference.mdgetting-inference.md) in docs/guides/README.md

Closes #762.

Test plan

  • make lint passes
  • All links from updated files resolve correctly

🤖 Generated with Claude Code

local-dev.md duplicated most of running-agents-locally.md. Its unique
content (build from source) moved to CONTRIBUTING.md; cross-platform
binary internals were already covered by cli-internals.md. All inbound
links updated. Closes #762.

Signed-off-by: Hector Martinez <hemartin@redhat.com>
@github-actions

Copy link
Copy Markdown

Site preview

Preview: https://77a4cf38-site.fullsend-ai.workers.dev

Commit: d1c6644196b0baa31b2958459613c8e45a4462a8

@fullsend-ai-review

fullsend-ai-review Bot commented Jun 11, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 2:57 PM UTC · Completed 3:09 PM UTC
Commit: d1c6644 · View workflow run →

@codecov

codecov Bot commented Jun 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

  • [scope-mismatch] docs/guides/dev/local-dev.md — The PR claims to close issue docs: add SA key creation steps to local-dev guide #762, which asked to add SA key creation steps to local-dev.md. The PR instead deletes local-dev.md entirely. The surviving running-agents-locally.md already contains the SA key gcloud commands (lines 64–74), so the underlying need is met, but the PR description should clarify this reasoning rather than implying the deletion itself resolves the issue.

  • [audience-classification-violation] CONTRIBUTING.md:42 — Build-from-source instructions are placed in CONTRIBUTING.md, which otherwise covers social norms and PR conventions. ADR-0023 leaves docs/guides/dev/ unchanged but doesn't prescribe content placement, so this isn't a hard violation — but a docs/guides/dev/ placement or a section in cli-internals.md would be more consistent with how other technical contributor content is organized.

  • [information-loss] docs/guides/dev/local-dev.md — The deleted file contains a "Security scanning and cross-platform binary" section with a binary resolution priority table (4 strategies: --fullsend-binary, GitHub Release download, cross-compile, latest release fallback), ELF validation behavior, and cross-compilation instructions. running-agents-locally.md mentions FULLSEND_SANDBOX_ARCH (line 287) and --fullsend-binary (line 311) only as brief troubleshooting tips, not with the detailed strategy context. Consider preserving this content in running-agents-locally.md or noting that it's intentionally dropped.

Low

  • [cross-reference-format] docs/guides/user/running-agents-locally.md:7 — The updated callout uses a quoted section name (see the "Building from source" section in CONTRIBUTING.md) instead of a clickable markdown link. Every other cross-reference in the changed files uses markdown link syntax. Consider: see [Building from source](../../CONTRIBUTING.md#building-from-source).

  • [cross-reference-completeness] docs/guides/dev/cli-internals.md:3,533 — Both cross-references in this developer-focused doc now point to the user-facing running-agents-locally.md. Since CONTRIBUTING.md now has the build instructions, consider adding a reference to that as well for developer readers.

Info

  • [broken-link-fix] docs/guides/README.md — The PR description mentions fixing a pre-existing broken link (-inference.mdgetting-inference.md), but this change is not visible in the diff. The only change to docs/guides/README.md is removing the local-dev.md link.

@fullsend-ai-review fullsend-ai-review Bot added the requires-manual-review Review requires human judgment label Jun 11, 2026
@rh-hemartin rh-hemartin self-assigned this Jun 11, 2026
@rh-hemartin rh-hemartin added this pull request to the merge queue Jun 15, 2026
Merged via the queue into main with commit d6f91ad Jun 15, 2026
10 checks passed
@rh-hemartin rh-hemartin deleted the fix/762-local-dev branch June 15, 2026 06:12
@fullsend-ai-retro

fullsend-ai-retro Bot commented Jun 15, 2026

Copy link
Copy Markdown

🤖 Finished Retro · ✅ Success · Started 6:17 AM UTC · Completed 6:24 AM UTC
Commit: d1c6644 · View workflow run →

@fullsend-ai-retro

Copy link
Copy Markdown

Retro: PR #2179 — docs consolidation

Timeline: Human-authored PR by rh-hemartin (branch fix/762-local-dev) opened 2026-06-11, review agent ran (~14 min), posted 3 medium + 2 low + 1 info findings with a ✅ Success verdict. Human (ralphbean) approved next day with no comment body. Merged 2026-06-15.

What went well:

  • Review agent completed quickly and produced structurally sound findings.
  • The information-loss finding correctly identified that binary resolution strategy documentation was being deleted without preservation.
  • The broken-link-fix Info finding correctly caught that the PR description claimed to fix a broken inference link (-inference.mdgetting-inference.md) that wasn't actually changed in the diff — a genuine discrepancy between PR description and actual changes.

What could go better:

  • The human reviewer approved without engaging with any of the 6 findings. The existing issue #2115 (use COMMENT verdict for human-authored PRs with only medium/low findings) already addresses the verdict calibration aspect of this problem.
  • The broken-link-fix finding was rated Info despite identifying a factual discrepancy between the PR description and diff. This class of finding — where the PR description claims changes not present in the diff — deserves higher severity since it may indicate missing changes or an inaccurate description.

Proposals: 1 new proposal filed. 1 skipped as duplicate of #2115.

Proposals filed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

requires-manual-review Review requires human judgment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add SA key creation steps to local-dev guide

2 participants