Skip to content

Add first-agent docs CLI parity check#4506

Merged
asim merged 1 commit into
masterfrom
codex/increment-4505
Jul 9, 2026
Merged

Add first-agent docs CLI parity check#4506
asim merged 1 commit into
masterfrom
codex/increment-4505

Conversation

@asim

@asim asim commented Jul 9, 2026

Copy link
Copy Markdown
Member

Summary

  • Add a provider-free test that compares README and website first-agent breadcrumbs against the maintained CLI wayfinding output for micro agent demo, micro examples, and micro zero-to-hero.
  • Wire the parity check into make docs-wayfinding and document when to run it.

Closes #4495
Closes #4505

Testing

  • make docs-wayfinding
  • go build ./...
  • go test ./... (fails in this environment due loopback proxy/provider constraints: ai atlascloud stream 400; client/grpc and transport/grpc loopback targets forbidden)
  • golangci-lint run ./...

@asim asim added the codex label Jul 9, 2026
Copilot AI review requested due to automatic review settings July 9, 2026 22:15
@asim asim added the codex label Jul 9, 2026
@asim asim merged commit a565dce into master Jul 9, 2026
6 checks passed
@asim asim deleted the codex/increment-4505 branch July 9, 2026 22:15

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a provider-free, deterministic “docs vs installed CLI” parity check so the first-agent onboarding breadcrumbs (README + website getting-started) stay aligned with the micro CLI wayfinding output and maintained no-secret paths.

Changes:

  • Adds TestFirstAgentDocsMatchCLIOutput to assert required first-agent markers exist in README/website docs and are reflected in micro docs/examples/zero-to-hero + micro agent demo outputs.
  • Wires the new parity test into make docs-wayfinding.
  • Updates the zero-to-hero CI harness README to document when/why to run the combined docs wayfinding + CLI parity guard.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
Makefile Extends docs-wayfinding to run the new CLI/docs parity tests.
internal/harness/zero-to-hero-ci/README.md Documents the expanded make docs-wayfinding contract and when to use it.
cmd/micro/first_agent_walkthrough_test.go Adds a provider-free test that compares doc markers against CLI wayfinding output and validates referenced paths exist locally.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread Makefile
Comment on lines 83 to +84
go test ./internal/harness/zero-to-hero-ci -run 'TestFirstAgentWayfindingDocs|TestFirstAgentWayfindingLinkTargetsResolve' -count=1
go test ./cmd/micro -run 'TestFirstAgentDocsMatchCLIOutput|TestFirstAgentWalkthroughCLIBoundaries' -count=1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Loop: build increment #166 Add first-agent docs command parity check

3 participants