docs: make Maple Cloud deployment checks discoverable to agents

Geschlossen
  • Stimmt etwas nicht?
#2,007 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@jasonkuhrt arbeitet bereits daran.

Seit 31.10.2026.

  • #2008 von @jasonkuhrt — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
typescript
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
TypeScript
Sterne
1.8k
Forks
120
Ø Merge
12 Std. 14 Min.
Gemergte PRs (30 T.)
760

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus MapleTechLabs/maple

Alle Issues in MapleTechLabs/maple

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.