docs: remove stale cmd/eyrie/ doc references#29
Merged
Conversation
The eyrie/docs/ARCHITECTURE.md Components diagram and the README.md build instructions both referenced a cmd/eyrie/ directory that does not exist — eyrie is a library, not a CLI. Reword the docs to reflect the library-only reality: - docs/ARCHITECTURE.md: drop the 'cmd/eyrie/' tree entry, keep the api/openapi.yaml entry (the OpenAPI spec documents the embedded HTTP server in internal/api, not a standalone binary). - README.md: replace 'go build ./cmd/eyrie' with 'go build ./...' to match Makefile:46 (the build target is just 'go build ./...' to verify the library compiles).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The eyrie/docs/ARCHITECTURE.md Components diagram and the README.md build instructions both referenced a
cmd/eyrie/directory that does not exist — eyrie is a library, not a CLI.cmd/eyrie/tree entry, keep theapi/openapi.yamlentry (the OpenAPI spec documents the embedded HTTP server ininternal/api, not a standalone binary).go build ./cmd/eyriewithgo build ./...to match Makefile:46 (the build target is justgo build ./...to verify the library compiles).Verification:
go build ./...✓go vet ./...✓go test ./client/ ./catalog/...✓origin/main(1↔1 divergence resolved; local commit dropped as duplicate)