Skip to content

docs: align architecture and examples with current behavior - #337

Merged
TMHSDigital merged 1 commit into
TMHSDigital:mainfrom
laozhej:docs/fix-documentation-drift-327-328
Nov 15, 2026
Merged

TMHSDigital merged 1 commit into
TMHSDigital:mainfrom
laozhej:docs/fix-documentation-drift-327-328

Conversation

@laozhej

@laozhej laozhej commented Nov 15, 2026

Copy link
Copy Markdown
Contributor

Description

Correct stale architecture identifiers and descriptions of optional wordlists, concurrent record lookups, streaming JSON, accepted resolver transports, and terminal scan events. Update the developer guide, resolver-pool and lab examples, lab flag restrictions, guide trees and wordlist-generator overwrite example to match the current source.

Related Issue

Fixes #327.
Fixes #328.

Type of Change

  • Documentation update

Validation

  • go test -race ./... passed across all packages (Go 1.27.4 on macOS arm64).
  • golangci-lint run passed with 0 issues (v2.15.0).
  • Built the CLI and generator, ran lab 1 locally and confirmed the documented dangling CNAME line, and ran the generator usage commands sequentially in a temporary directory.
  • Compared the remaining statements and identifiers with their source; git diff --check passed.

Checklist

  • Read docs/CONTRIBUTING.md.
  • Updated documentation.
  • Existing unit tests and race checks passed.

Ethical Considerations

Documentation corrections; scan behavior and safeguards are unchanged. The lab verification used its loopback DNS server.

Additional Information

AI assistance: OpenAI Codex prepared, inspected and verified this change. No independent human review is claimed.

@TMHSDigital
TMHSDigital merged commit ce93d0a into TMHSDigital:main Nov 15, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Small doc errors: landing page, DEVELOPER_GUIDE, labs.md, tools/README ARCHITECTURE.md names missing identifiers and describes replaced behavior

2 participants