Skip to content

docs(drift): draft from internal source#342

Open
pedromcunha wants to merge 1 commit into
mainfrom
docs-drift/src-c59f19b66d-d51b129
Open

docs(drift): draft from internal source#342
pedromcunha wants to merge 1 commit into
mainfrom
docs-drift/src-c59f19b66d-d51b129

Conversation

@pedromcunha

Copy link
Copy Markdown
Member

Drafted from an internal source repo, requested by @alexanderattar.

This PR was auto-generated by the reusable-docs-draft-pr workflow from a Claude-drafted update in the source repo. It is opened as a draft — please review, edit as needed, and mark ready for review before merging.

Review checklist

  • Content matches the behavior shipped in the source PR
  • No internal-only details (service names, file paths, unreleased names, security internals) leaked into the draft
  • Conforms to CLAUDE.md style rules
  • Cross-references and internal links resolve
  • Any Needs human input items from the source comment are addressed

Generated by reusable-docs-draft-pr.yml in relayprotocol/agents-config.

Requested by @alexanderattar via /publish-docs-pr
@mintlify

mintlify Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
unevenlabs 🟢 Ready View Preview Jun 19, 2026, 2:56 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@pedromcunha pedromcunha marked this pull request as ready for review June 19, 2026 10:58
@github-actions

github-actions Bot commented Jun 19, 2026

Copy link
Copy Markdown

Claude finished @pedromcunha's task in 1m 11s —— View job


Code review — PR #342

  • Gather context (diff, changelog page, style guide)
  • Review changelog entry for correctness & style conformance
  • Post review feedback

This PR adds one new entry (dated 2026-06-19) to references/api/changelog.mdx describing TON inTxs[].hash returning a bare explorer-ready hex hash, plus a new explorerPaths.transaction field on GET /chains.

Verdict

Looks good. The entry conforms to the changelog format in AGENTS.md §4.5 and reads cleanly. No blocking issues. A few notes below — mostly judgment calls for the human reviewer.

Style / format conformance ✅

  • Newest-first ordering preserved (2026-06-19 sits above 2026-06-10) — §4.5 ✓
  • ## heading with date + one-line summary ✓
  • Bolded change-type leads on their own lines ✓
  • **Behavior change** lead matches established precedent in this file (e.g. the 2026-06-10 and 2026-06-05 entries) even though it isn't in the §4.5 canonical list (Breaking/Deprecated/Added)
  • Endpoints/fields backticked, paragraphs within the 2–3 sentence guidance (§2.10) ✓
  • No internal-only leakage — "internal composite identifier" describes prior external behavior, no service names or file paths ✓

Notes for the reviewer (non-blocking)

  1. Breaking vs Behavior change classification. The inTxs[].hash value format changes from a composite identifier to a bare hex hash. Any integrator that parsed the old composite value will break, which fits the §4.2 definition of a breaking change (return-shape change). The file does use **Behavior change** for analogous value changes (2026-06-10), so this is defensible and consistent — just flagging that "Breaking" is arguably the stricter-correct lead here. The author's call.

  2. Consistency check passes. The two leads agree: the behavior change says the hash is now openable at /transaction/{TX_HASH}, and the Added entry exposes explorerPaths.transaction as exactly that path (vs. the old hardcoded /tx/{TX_HASH}). Coherent. ✓

  3. No companion page edits needed. Per §3.3, the endpoint reference pages are OpenAPI-driven stubs, so the field/value change is captured by the spec, not MDX prose. Changelog-only is the right surface here.

  4. No links to resolve — the entry introduces no internal cross-references, so there's nothing to break. (Optional: if a TON integration guide exists, a link on first mention of TON could help, but the surrounding entries don't link chain names either, so leaving it out is consistent.)

Nice, tidy changelog draft.

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.

3 participants