docs: comprehensive rewrite of .agent/ documentation suite#36
Merged
Conversation
- ARCHITECTURE.md: Added complete file tree, custom http.Transport details, SSRF/open-redirect protection docs, dual deserialization paths (do vs doRaw), originURL caching with double-checked locking, full client struct field table, CI/CD pipeline docs, and 8 Makefile target descriptions - PHILOSOPHY.md: Corrected error handling docs (errors.As only, not errors.Is), added SSRF/open-redirect defense-in-depth rationale, User-Agent spoofing strategy explanation, EeroTime dual-format resilience, dual deserialization strategy, explicit security boundary model, and concrete anti-pattern list - STYLE.md: Added net/url and sync to allowed packages list, documented all 5 test file naming patterns (was only showing 3), added HTTP method usage table, request construction patterns (newRequest vs newRequestFromURL), buildRequest factory pattern, and expanded anti-pattern list from 5 to 9 items - TESTING.md: Removed phantom tests (TestClient_HitPayloadLimit, fabricated 10-goroutine race test), added complete 12-file test inventory with all test names, documented 7 benchmarks, BaseURL configuration rules for httptest, session cookie seeding patterns, internal vs external test packages, and verified regression matrix with exact test run commands - STATUS.md: Replaced stale task table with complete API method inventory (9 methods), full data model count (60+ exported structs), build/CI status dashboard, known limitations, development lifecycle guide, and concrete roadmap with 6 future items Verified: All tests pass with race detection (go test -v -race ./...)
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.
Summary
Production-grade rewrite of all five
.agent/documentation files based on a deep file-by-file audit of every source file, test file, CI config, Makefile, and git hook in the repository.What Changed
ARCHITECTURE.md
http.Transportconfiguration (connection pools, timeouts, HTTP/2)do()vsdoRaw())originURL()caching with double-checked locking patternPHILOSOPHY.md
errors.As()only — removed incorrecterrors.Is()claim)EeroTimedual-format resilience as a philosophy pointSTYLE.md
net/urlandsyncto allowed packages (were missing)newRequestvsnewRequestFromURL)TESTING.md
TestClient_HitPayloadLimit, fabricated 10-goroutine race test)STATUS.md
Verification
go test -v -race ./...✅