IntersectMBO / IntersectMBO/evolution-sdk

docs: Data guide is missing withSchema, toHash, DataEncoded, DataError, and a helper API reference

オープン
#154 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
documentation enhancement
主要言語
TypeScript
スター
22
フォーク
30
平均マージ
5時間 29分
マージ済み PR(30日)
12

説明

## Problem

The Data guide page at \`docs/content/docs/encoding/data.mdx\` covers the five PlutusData types and basic CBOR encoding well, but is missing several important areas of the \`Data\` module.

### Missing Sections

**Data.withSchema()** — The most important bridge between raw \`Data\` and \`TSchema\`. The page mentions TSchema at the bottom but never explains \`Data.withSchema()\` itself, the codec it returns (\`toData\`, \`fromData\`, \`toCBORHex\`, \`toCBORBytes\`, \`fromCBORHex\`, \`fromCBORBytes\`), or where this API lives relative to raw Data manipulation.

**Data.toHash()** — Computing a datum hash from PlutusData is a core operation when attaching non-inline datums to transactions. This is absent from the guide.

**DataEncoded type** — The JSON-serializable representation of PlutusData (used by node APIs, block explorers, and CML interop). Not mentioned.

**DataError** — Error handling when decoding fails. The error type exists but is never referenced in the guide.

**Helper API reference** — \`Data.constr()\`, \`Data.map()\`, \`Data.toCBORHex()\`, \`Data.fromCBORHex()\`, \`Data.toCBORBytes()\`, \`Data.fromCBORBytes()\`, \`Data.equals()\` are all used in examples but there is no dedicated reference section listing each with its signature and behavior.

**Constr class vs constr helper** — The \`Constr\` class (with \`index\` and \`fields\`) and the \`Data.constr()\` convenience function both exist but the distinction is not explained anywhere in the guide.

### Acceptance Criteria

- [ ] \`Data.withSchema()\` has its own section with codec API documented (\`toData\`, \`fromData\`, \`toCBORHex\`, etc.)
- [ ] \`Data.toHash()\` is documented with an example showing datum hash computation
- [ ] \`DataEncoded\` type is explained — what it is, where it comes from, when you encounter it
- [ ] \`DataError\` and decoding error handling is covered
- [ ] A Reference section enumerates all helper exports with signatures and one-line descriptions
- [ ] \`Constr\` class vs \`Data.constr()\` helper distinction is clarified
- [ ] All examples use \`twoslash\` code fences and compile

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Start with docs/content/docs/encoding/data.mdx and review its existing Data and TSchema coverage alongside the named APIs: withSchema, toHash, DataEncoded, DataError, helper exports, and Constr. Done means adding the requested sections, reference entries, examples, and Constr distinction, with every example using twoslash fences and compiling.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。