[docs] Chainweb API - Move data models and binary encoding into main docs

kadena-community / kadena.js

Public monorepo for all Typescript/Javascript related tools and libs for Kadena

https://docs.kadena.io

BSD 3-Clause "New" or "Revised" License

32 stars 23 forks source link

[docs] Chainweb API - Move data models and binary encoding into main docs #2424

Closed lsgunnlsgunn closed 1 month ago

lsgunnlsgunn commented 1 month ago

Chainweb OpenAPI spec has Data Models and Binary Encoding sections.

https://kadena-io.github.io/chainweb-openapi/#tag/cut_model

This PR converts those sections to standard Markdown to be included in the docs site.

Related Issue/Asana ticket: _

Short description: _

Test scenarios

description of the (manually) executed test scenarios

Reminders (if applicable)

[ ] I ran pnpm install and pnpm test in the root of the monorepo (optionally with --filter=...package... to exclude non-affected projects)
[ ] I ran pnpm changeset in the root of the monorepo
[ ] Test coverage has not decreased
[ ] Docs have been updated to reflect changes in PR (don't forget docs.kadena.io)

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
alpha-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 19, 2024 6:01pm
dev-wallet	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 19, 2024 6:01pm
explorer	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 19, 2024 6:01pm
kode-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 19, 2024 6:01pm
marmalade-marketplace	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 19, 2024 6:01pm
proof-of-us	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 19, 2024 6:01pm
tools	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 19, 2024 6:01pm

changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: bef54a1efa75e98a638f3dd6633f43eac670bf15

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR