Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add Notes page #2943

Closed
Tracked by #2658 ...
critesjosh opened this issue Oct 20, 2023 · 3 comments · Fixed by #4690
Closed
Tracked by #2658 ...

docs: Add Notes page #2943

critesjosh opened this issue Oct 20, 2023 · 3 comments · Fixed by #4690
Assignees
Labels
A-documentation Area: relates to documentation T-feedback Type: recording user feedback

Comments

@critesjosh
Copy link
Contributor

critesjosh commented Oct 20, 2023

Add a page to the docs about Notes (to the Foundational Concepts section, or after Storage in dev docs?).

Be sure to include information about the best way to add info about a note that is created in a public function to the PXE. See this e2e test for an example of how this is done with the TransparentNote in the token contract example.

  • everything from how to use, create, destroy
  • explanations of interfaces and functions
  • understanding storage from the context of notes
@critesjosh critesjosh added A-documentation Area: relates to documentation T-feedback Type: recording user feedback labels Oct 20, 2023
@critesjosh
Copy link
Contributor Author

related issue #2914

@jzaki
Copy link
Contributor

jzaki commented Jan 27, 2024

  • Surrounding knowledge on storage trees, create/read/nullify, use in pxe, tx execution,
  • [ ] Coding example(s)
  • Draft content
  • put in docs

@critesjosh
Copy link
Contributor Author

I am thinking this page should be more of an explainer than a how to or a guide. What are you thinking?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: relates to documentation T-feedback Type: recording user feedback
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants