Skip to content

docs: update README according to organization standards#1867

Open
aleortega wants to merge 2 commits intomainfrom
docs/update-README
Open

docs: update README according to organization standards#1867
aleortega wants to merge 2 commits intomainfrom
docs/update-README

Conversation

@aleortega
Copy link
Member

This PR updates the main README to follow the organization standards.

- **Content Retrieval**: Provides endpoints to retrieve raw binary files associated with deployed entities
- **Snapshots Retrieval (sync)**: Provides an endpoint to retrieve snapshots generated by the node, which contain all historical deployments that have happened within a specific time frame
- **Collections Retrieval**: Provides endpoints to retrieve information about item collections
- **Users Items Retrieval**: Provides endpoints to retrieve a user's wearables, emotes, and outfits (off-chain and on-chain items, including linked NFTs)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Users Items Retrieval**: Provides endpoints to retrieve a user's wearables, emotes, and outfits (off-chain and on-chain items, including linked NFTs)
- **Users Items Retrieval**: Provides endpoints to retrieve a user's wearables, emotes, and outfits (off-chain and on-chain items, including linked-wearables associated with external NFTs ownership)

- **Snapshots Retrieval (sync)**: Provides an endpoint to retrieve snapshots generated by the node, which contain all historical deployments that have happened within a specific time frame
- **Collections Retrieval**: Provides endpoints to retrieve information about item collections
- **Users Items Retrieval**: Provides endpoints to retrieve a user's wearables, emotes, and outfits (off-chain and on-chain items, including linked NFTs)
- **DAO List Fetch**: Provides endpoints to retrieve nodes participating in the Catalyst network (nodes listed in the DAO list that officially replicate content)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **DAO List Fetch**: Provides endpoints to retrieve nodes participating in the Catalyst network (nodes listed in the DAO list that officially replicate content)
- **DAO List Fetch**: Provides endpoints to retrieve nodes participating in the Catalyst network (nodes listed in the DAO smart contract that officially replicate content)


- **Content Server** (`content/`): Entity storage and synchronization
- **Lambdas Server** (`lambdas/`): Utility APIs for clients

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note: Lambdas API has been reimplemented and migrated to [lamb2](https://github.com/decentraland/lamb2/). Once the full migration is completed the lambdas portion won't be part of this repository.

Copy link
Member

@pentreathm pentreathm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
left some minor comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants