docs: documentation for account compression program #3998
Conversation
|
TS usage / examples look good. Explanation of algorithm is excellent, but a little bit off. Will highlight particular lines Can you explain what the |
Docusaurus wasn't serving the page for me on localhost 3000 without specifying the host and port on the start command, after that it did serve the page but gave an error saying switchConfig is undefined which was fixed after updating the packages |
|
Please undo your package json changes |
|
Otherwise, this looks good. Will need some touch up after merging, but looks good to me. Great work! Can you remove the digital asset examples? Those are bound to be out of date soon |
Thanks! Made both the changes, glad I could contribute and thanks for coordinating, looking forward to doing more contributions |
|
Looks good to me. cc @joncinque for help with reviewing changes to Docusaurus |
* docs: added account compression to sidebar * docs: added account compression page * docs: added concepts * docs: added more core concepts + usage docs * fix: remove extra column in table * fix: fixed error in swap example * fix: revert package.json changes for docs * docs: remove digital asset ex from compression docs * Address nit --------- Co-authored-by: Noah Gundotra <[email protected]>
I've added documentation for the account compression program. Here's a summary of the changes.
I've added 3 pages:
Overview contains brief on the program, motivation, background, packages and guide to run the tests.
Usage contains examples to use the TS SDK
Core concepts contains a concise explanation of the core technology used in account compression and how it ties into compressing NFTs with easy to understand examples.