docs: name the indexer atomicassets-api outside alias and channel-literal contexts - #2
Merged
Merged
Conversation
…eral contexts Four sentences still called the software eosio-contract-api as its name rather than as the documented alias. The remaining occurrences are deliberate: the naming section itself, the formerly/also-known-as alias mentions, and the filler's Redis channel string, which really is named eosio-contract-api.
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s reference documentation to consistently use atomicassets-api as the canonical name for the indexer/API project, while intentionally preserving eosio-contract-api where it is historically accurate (alias explanations) or semantically required (the Redis channel literal).
Changes:
- Replaced non-literal mentions of
eosio-contract-apiwithatomicassets-apiin API behavior and V2 upgrade compatibility documentation. - Clarified the “legacy 1.3.x filler” wording to keep the historical name only in an explicit historical-name context.
- Kept the
eosio-contract-api:<chain>:<reader>:apiRedis channel string unchanged (as intended by the PR description).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| reference/atomicassets/v2-upgrade.md | Rewords the legacy filler reference to avoid naming the project as eosio-contract-api except as an explicit historical-name note. |
| reference/atomicassets-api.md | (Context remains consistent) Continues to document canonical vs historical naming for the indexer/API project. |
| reference/api.md | Updates API behavior descriptions to refer to atomicassets-api instead of eosio-contract-api outside alias/channel-literal contexts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Four sentences named the software eosio-contract-api directly instead of atomicassets-api, the canonical name the repo itself establishes. The alias explanations, the historical-name section, and the literal Redis channel string (which really is eosio-contract-api:::api) are unchanged on purpose.
Validation
Grep for eosio-contract-api now hits only the alias/naming contexts and the channel literal.