feat: Add documentation and examples for Community tables and PublicPermissionless Tables #11
Conversation
PublicPermissionless Tables
AdaJane-SxT
force-pushed
the
feat/tables
branch
from
f364b52 to
27389e0
Compare
tlovell-sxt
left a comment
tlovell-sxt
left a comment
There was a problem hiding this comment.
not done reviewing but one quick comment
| @@ -0,0 +1,50 @@ | |||
| # Community Tables | |||
There was a problem hiding this comment.
These should probably be in a explanation directory, if we're doing the 4 types of documentation in different directories
There was a problem hiding this comment.
A lot of this is presumably copied from the existing Hello World tutorial. It would be nice to avoid duplication, at least to make updating it easier.
That being said, I'm not sure the best way to do that since I don't really want people to have to jump around following links everywhere.
There was a problem hiding this comment.
This kinda makes me think we should just have a community tutorial and a public-permissionless tutorial and no hello world tutorial. I think this is basically the hello world tutorial with extra information about permissioning. Or maybe we just have links to how-to-guides for the repeated steps
Though maybe that's a more major change that should be sort of a follow-up refactor
| Assigned a unique table ID | ||
| Associated with an initial table owner (the signer of the DDL transaction) | ||
| Registered in the SXT Chain under consensus | ||
| Bound to a cryptographic commitment representing the table’s state (initially empty) |
There was a problem hiding this comment.
it looks like github's markdown renderer recognizes this as a code block? Somehow?
It'd probably be fine to just use a numbered list or bullets instead though
| Public/Permissionless Tables: Any user can submit data (e.g., public content feeds or game leaderboards). | ||
| Community Tables: Only the table owner (or a whitelisted set of public keys) can insert data. Useful for oracle publishers or protocol-owned datasets. |
There was a problem hiding this comment.
Same comment here, bullets would be fine.
| | Table Creation | 20 SXT per Table | | ||
| | Namespace Creation | 20 SXT per Schema | | ||
| | Row Inserts | ~0.02 SXT per row | |
There was a problem hiding this comment.
Might want to mention 20 SXT "+ gas"?
| EMAIL VARCHAR NOT NULL, | ||
| CREATED_AT BIGINT NOT NULL, | ||
| PRIMARY_KEY(USER_ID) | ||
| ); |
There was a problem hiding this comment.
This is kinda getting into "guide" territory, I think. I wonder if it would be best if this page was more of a compare/contrast of BOTH community tables, and public tables, with links to their respective tutorials instead of examples. Then the tutorials, in their brief explanation of their respective table types, could link back here as a "see this page to learn about other table types" or w/e
|
|
||
| ### Option A: Manual Funding | ||
|
|
||
| To manually fund your wallet, you can follow the instructions in the [Hello World Tutorial](../../hello_world_tutorial/HELLO_WORLD_TUTORIAL.md) |
There was a problem hiding this comment.
This link is broken, I think it just needs one ../?
There was a problem hiding this comment.
This kinda makes me think we should just have a community tutorial and a public-permissionless tutorial and no hello world tutorial. I think this is basically the hello world tutorial with extra information about permissioning. Or maybe we just have links to how-to-guides for the repeated steps
Though maybe that's a more major change that should be sort of a follow-up refactor
No description provided.