docs: make Maple Cloud deployment checks discoverable to agents

Đã đóng
  • Có gì không ổn?
#2,007 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

@jasonkuhrt đang làm issue này rồi.

Từ ngày 31/10/2026.

  • #2008 của @jasonkuhrt — đang mở

Đá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
25/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Start with the AI agent guide at docs/getting-started/ai-agents.md and llms.txt, then check the existing wording in the guide’s Changelog section. Document runnable checks for the listed US and EU endpoints, including the requested region, freshness, revision-header, merge-commit, and dashboard/API distinctions. Done when llms.txt links to the guide, the Changelog wording is corrected, and both files explain how to verify serving revisions.

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

Mô tả

Written by an AI agent (Codex) on behalf of @jasonkuhrt.

An agent waiting for a Maple Cloud fix needs to distinguish “merged” from “running in my region.” The agent-facing documentation currently points to the product changelog and GitHub releases, but does not explain the existing deployed-revision checks.

Maple already serves public, browser-free signals:

  • GET https://app.maple.dev/version.json: the dashboard asset build's commit.
  • GET https://api.maple.dev/health: the running API Worker's x-maple-revision response header.
  • The equivalent EU endpoints use app.eu.maple.dev and api.eu.maple.dev.

The AI agent guide already owns MCP workflows and public instrumentation skills. It has no deployment-check workflow, and llms.txt does not directly link to that guide.

Please document these existing checks with runnable requests in the guide and link it from llms.txt. Explain region selection, fresh responses, absent revision headers, checking the actual upstream merge commit against serving revisions, and the separate dashboard/API scope. Correct the Changelog section's “one entry per shipped change” wording and point it to the revision checks: an announcement does not identify a region's running commit.

This arose while tracking #2000. It can be solved through the existing agent entry points without adding another endpoint or a general-purpose skill.

Ngôn ngữ chính
TypeScript
Star
1.8k
Fork
120
Merge trung bình
10 giờ 37 phút
Pull request đã merge (30 ngày)
708

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 MapleTechLabs/maple

Tất cả issue của MapleTechLabs/maple

Issue tương tự

Thêm issue về TypeScript

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.