📚 Documentation Reconciliation Report - 2026-11-13

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#16,482 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
76/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
go
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Bắt đầu từ các đăng ký flag trong internal/cmd/proxy.go (khoảng dòng 158-185), ghi chú giá trị mặc định và văn bản trợ giúp của từng flag, bao gồm cả lệnh gọi registerTracingFlags cho các flag OTLP. Sau đó mở bảng Flags trong docs/PROXY_MODE.md (khoảng dòng 172-188) và so sánh với các đăng ký đó. Hoàn thành khi bảng có các dòng cho --force-public-repos, --wasm-cache-dir và ba flag --otlp-*, với giá trị mặc định khớp với mã nguồn.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

automated documentation maintenance

Summary

Found 1 minor discrepancy between documentation and implementation during the nightly reconciliation check.

Critical Issues 🔴

None found.

Important Issues 🟡

None found.

Minor Issues 🔵

1. awmg proxy flag table in docs/PROXY_MODE.md is missing several flags

Location: docs/PROXY_MODE.md, "Flags" table (around lines 172-188)
Problem: The table does not list these flags, which are registered in internal/cmd/proxy.go:

  • --force-public-repos (line 173; default is taken from MCP_GATEWAY_FORCE_PUBLIC_REPOS, otherwise true)
  • --wasm-cache-dir (line 165; default is a sibling wazero-cache directory next to --log-dir)
  • --otlp-endpoint, --otlp-service-name and --otlp-sample-rate, registered through registerTracingFlags

Actual Behavior: All of these flags are accepted by awmg proxy. --force-public-repos is not mentioned in any Markdown file. --wasm-cache-dir appears only in the gateway flag list in README.md (line 67) and in the MCP_GATEWAY_WASM_CACHE_DIR entry of docs/ENVIRONMENT_VARIABLES.md.
Impact: Proxy users cannot discover these flags from the proxy documentation. This is especially relevant for --force-public-repos, which changes the effective guard policy.
Suggested Fix: Add rows for the flags above to the docs/PROXY_MODE.md Flags table, with defaults and descriptions taken from the flag help text in internal/cmd/proxy.go.
Code Reference: internal/cmd/proxy.go:158-185

Documentation Completeness

Missing Documentation
  • The proxy flags listed above.
Outdated Documentation
  • None found.
Accurate Sections ✅
  • Go version: go.mod, Makefile (GO_VERSION), CONTRIBUTING.md, README.md and AGENTS.md all say 1.26.10.
  • Quick Start JSON stdin example: the gateway section is required with port and domain, matching internal/config/schema/mcp-gateway-config.schema.json (required port and domain, with agentId or agentIds).
  • Server fields (type, container, entrypoint, entrypointArgs, args, mounts, env, connectTimeout, toolTimeout) all exist in StdinServerConfig. No command field is documented for JSON stdin.
  • Gateway fields in the README.md table match StdinGatewayConfig in internal/config/config_stdin.go.
  • Every non-test os.Getenv / os.LookupEnv variable in internal/ and main.go is documented. The only undocumented names in the scan were test fixtures and GITHUB_ACTIONS, which I did not investigate further.
  • Every awmg flag registered in internal/cmd is documented somewhere in the docs, apart from the proxy flags above. The scan also flagged --verbose, a Cobra counter flag shown as -v/-vv in CONTRIBUTING.md.
  • All relative links in README.md and CONTRIBUTING.md that point into docs/, internal/, scripts/ and test/ resolve to existing files.

Tested Commands

  • ✅ Every make target named in CONTRIBUTING.md and AGENTS.md exists in the Makefile: build, test, test-unit, test-integration, test-all, test-ci, lint, coverage, install, format, clean, agent-finished.
  • ⚠️ make build could not be verified. The sandbox firewall blocked proxy.golang.org (TLS certificate error), so module downloads failed and the awmg binary was not produced. As a result ./awmg --help was not run; I checked flags statically from internal/cmd/*.go instead.
  • ⚠️ The external spec link (https://github.com/github/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md) and the token page link were not checked, because network access is restricted.

Recommendations

Immediate Actions Required:

None.

Nice to Have:
  1. Add the missing proxy flags to docs/PROXY_MODE.md.

Code References

  • Proxy flags: internal/cmd/proxy.go
  • Configuration structs: internal/config/config_core.go, internal/config/config_stdin.go
  • Validation logic: internal/config/validation_schema.go (and internal/config/schema/mcp-gateway-config.schema.json)

Generated by Nightly Documentation Reconciler · copilot · routed: sonnet55 high · ~35 AIC · ⊞ 2.1K · ◷

  • expires on Nov 16, 2026, 10:45 PM UTC
Ngôn ngữ chính
Go
Star
188
Fork
60
Merge trung bình
6 giờ 45 phút
Pull request đã merge (30 ngày)
198

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/gh-aw-mcpg

Tất cả issue của github/gh-aw-mcpg

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.