Skip to content

docs: Add Notes page #2943

Closed
#4690
Closed
docs: Add Notes page#2943
#4690
Assignees
jzaki
Labels
A-documentationArea: relates to documentationT-feedbackType: recording user feedback

Description

@critesjosh
critesjosh
opened on 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

Activity

  1. critesjosh
    added
    A-documentationArea: relates to documentation
    T-feedbackType: recording user feedback
    on Oct 20, 2023

  2. critesjosh commented on Oct 20, 2023

    @critesjosh
    critesjosh
    on Oct 20, 2023
    ContributorAuthor

    related issue #2914

  3. github-project-automation
    added this to A3on Dec 7, 2023
  4. github-project-automation
    moved this to Todo in A3on Dec 7, 2023
  5. critesjosh
    assigned
    jzaki
    on Jan 24, 2024

  6. jzaki commented on Jan 27, 2024

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

  7. critesjosh commented on Jan 30, 2024

    @critesjosh
    critesjosh
    on Jan 30, 2024
    ContributorAuthor

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

  8. jzaki
    closed this as completedin #4690on Feb 29, 2024
  9. jzaki
    added a commit that references this issue on Feb 29, 2024

    docs: add Notes page to build section (#4690)

    6582b09
  10. github-project-automation
    moved this from Todo to Done in A3on Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-documentationArea: relates to documentationT-feedbackType: recording user feedback

Type

No type

Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions