docs: use the protocol's own vocabulary for the asset category - #3
Merged
Conversation
The contract, table, and API vocabulary never uses the industry category label; describing assets in the protocol's own nouns is more precise and keeps the corpus consistent with the sources it cites. Sixteen prose lines across eleven files swap the category label for asset-based phrasing; no fenced snippet, identifier, error string, or technical claim changes. The settlement actions' movement labels now read as the consistent pair Token movement and Asset movement.
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation corpus to use the protocol’s own vocabulary (primarily “asset” / “AtomicAssets asset”) instead of the industry label previously used in prose, while leaving fenced snippets, identifiers, and technical claims unchanged.
Changes:
- Replaces prose references to the old category label across multiple guides and reference pages.
- Standardizes AtomicMarket settlement descriptions to a consistent “Token movement” / “Asset movement” wording.
- Updates high-level routing/index docs (README, AGENTS, skill docs) to match the revised vocabulary.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/atomic-integration/SKILL.md | Adjusts skill trigger wording to “Atomic ecosystem” vocabulary. |
| reference/sdk/atomicassets.md | Updates SDK description prose to use “asset” terminology. |
| reference/media.md | Renames scope/intro prose to “asset media” terminology. |
| reference/atomictools/actions.md | Updates AtomicTools contract description to remove the old label in prose. |
| reference/atomicmarket/actions.md | Standardizes settlement “movement” wording into Token/Asset movement pair. |
| reference/atomicassets/structure.md | Updates AtomicAssets data model description to “assets” terminology. |
| reference/atomicassets/backing-tokens.md | Updates backing-token prose to remove the old label. |
| README.md | Updates repository description and “Media” row wording to match revised vocabulary. |
| guides/links.md | Updates claim-link guide prose to “assets” terminology. |
| guides/asset-lifecycle.md | Updates guide title to revised vocabulary. |
| AGENTS.md | Updates routing-table entry label to “Asset media”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## The balances table is a general-purpose deposit ledger | ||
|
|
||
| `balances_s` is one row per owner holding a vector of `asset` quantities, one entry per announced symbol, with no link to any specific NFT. `withdraw` spends directly out of this pool back to the owner's wallet through the token contract recorded in `supported_tokens`. Historically `backasset` spent out of the same pool to attach value to an asset. The table itself is not backing-specific; it is whatever pre-funded balance any contract action needs. | ||
| `balances_s` is one row per owner holding a vector of `asset` quantities, one entry per announced symbol, with no link to any specific asset. `withdraw` spends directly out of this pool back to the owner's wallet through the token contract recorded in `supported_tokens`. Historically `backasset` spent out of the same pool to attach value to an asset. The table itself is not backing-specific; it is whatever pre-funded balance any contract action needs. |
| --- | ||
|
|
||
| # Asset lifecycle: creating and managing AtomicAssets NFTs | ||
| # Asset lifecycle: creating and managing assets |
| # Media conventions | ||
|
|
||
| How an Atomic NFT points at its media, and what an integrator must do to render it. The chain stores no image bytes and no media column: media is carried as ordinary schema attributes whose values are IPFS references, under field names that are collection convention rather than contract rule. This page covers those conventions and how to resolve them. The wire encoding of the `ipfs` and `image` FORMAT types is in `reference/atomicassets/serialization.md`; the V2 `FORMAT_TYPE` media-type mechanism is in `reference/atomicassets/custom-types.md`; which data layer a given attribute comes from is in `reference/atomicassets/data-precedence.md`. This file does not restate those. | ||
| How an Atomic asset points at its media, and what an integrator must do to render it. The chain stores no image bytes and no media column: media is carried as ordinary schema attributes whose values are IPFS references, under field names that are collection convention rather than contract rule. This page covers those conventions and how to resolve them. The wire encoding of the `ipfs` and `image` FORMAT types is in `reference/atomicassets/serialization.md`; the V2 `FORMAT_TYPE` media-type mechanism is in `reference/atomicassets/custom-types.md`; which data layer a given attribute comes from is in `reference/atomicassets/data-precedence.md`. This file does not restate those. |
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
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.
Why
The corpus described the category with the industry label while the contracts, tables, and API it cites never use that word. Sixteen prose lines across eleven files now use the protocol's own nouns instead; fenced snippets, identifiers, error strings, and technical claims are untouched. The settlement actions' movement labels become the consistent pair Token movement and Asset movement (one pre-existing plain Token movement label at the bid action already used the target form).
Validation
A case-insensitive grep for the label and its variants across all markdown returns zero hits; every changed line sits outside fenced code; the diff is sixteen one-to-one line replacements across eleven files.