Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
|
wilwade
requested review from
a team,
JoeCap08055,
aramikm,
claireclark1,
enddynayn,
mattheworris and
shannonwells
and removed request for
a team
Co-authored-by: Joe Caputo <joseph.caputo@unfinished.com>
shannonwells
left a comment
shannonwells
left a comment
There was a problem hiding this comment.
Nothing blocking, only suggestions
pallets/messages/README.md
Outdated
| ## Summary | ||
|
|
||
| Messages stores metadata and message payload data for a set Schema. | ||
| Use of the Message pallet payloads is designed for time-centric data. |
There was a problem hiding this comment.
Time-centric? As in, time is the thing a payload revolves around?
Perhaps you mean time-based?
This is also awkward:
Use of the Message pallet payloads...
Perhaps,
| Use of the Message pallet payloads is designed for time-centric data. | |
| Message payloads are meant for time-[whatever] data. |
There was a problem hiding this comment.
Trying out this one:
Message payloads are meant for streaming data, where when the message was sent is the focus.
There was a problem hiding this comment.
Merging for now, but let me know if you have thoughts/better ideas and we can tweak it in one of the other docs PRs.
pallets/messages/README.md
Outdated
| ### Payload Options | ||
|
|
||
| - `IPFS`: Storage of the CID and length of the file on IPFS | ||
| - `OnChain`: Storage of the entire payload data. Usually for tiny payloads only. |
There was a problem hiding this comment.
not a big deal but what does tiny mean?
There was a problem hiding this comment.
Updated to:
- OnChain: Storage of the entire payload data, usually for sub-256 byte payloads
There was a problem hiding this comment.
Merging for now, but let me know if you have thoughts/better ideas and we can tweak it in one of the other docs PRs.
mattheworris
left a comment
mattheworris
left a comment
There was a problem hiding this comment.
Lookin' good, 🚢 it!
6 participants
Goal
The goal of this PR is to improve the documentation of the Pallets and make that documentation be able to be used on docs.frequency.xyz.
Part of frequency-chain/docs#59
Discussion
Screenshot