refactor: reframe introduction as the OpenAPI of UTxO#41
Merged
Conversation
Promote the interface-description framing to the lead of the docs index and reorganise the page into Two sides of the workflow / Why UTxO protocols need this / What's in the toolkit / Where the OpenAPI analogy ends / Not a smart contract language. CardGrids preserved verbatim. Also add a one-line positioning sentence to the language guide so it reads as the authoring face of Tx3. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Remove OpenAPI from the lead sentence and delete the "Where the OpenAPI analogy ends" section. Rewrite "Why UTxO protocols need this" so the EVM ABI is the primary analogy and OpenAPI is mentioned as a parallel from the web layer. Also folds in the in-flight wording tweaks to the lead and to the Two-sides section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Lead with OpenAPI as the Web2 solution and follow with the EVM ABI as the contract-layer solution, in two distinct paragraphs. Also replace the misleading "format vs toolchain" lead-in to the Two-sides section with one that names the actual contrast — author vs consumer.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
index.mdxwith the interface-description framing — Tx3 as the OpenAPI of UTxO — promoted from a buried single sentence to the opening paragraph.language/index.mdxso the language guide reads as the authoring face of Tx3.The OpenAPI analogy was already present in the previous intro, but a single buried clause; this change makes it the lead and rebuilds the surrounding sections to support it. Both sides of the workflow (authoring and consuming) are now equally visible.
Test plan
index.mdx→quick-start.mdx→language/index.mdx→integration/index.mdx. Framing should be consistent across pages.🤖 Generated with Claude Code