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

Feat/guide/working with data #449

Merged
merged 63 commits into from
May 24, 2024
Merged

Feat/guide/working with data #449

merged 63 commits into from
May 24, 2024

Conversation

pdaoust
Copy link
Collaborator

@pdaoust pdaoust commented Apr 18, 2024

Add an overview page for working with data in Holochain. Covers actions/records, entries, links, CRUD, and source chains.

Copy link

@c12i c12i left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This documentation looks great, and the illustrations effectively help with visualization! However, I believe adding some code examples would significantly enhance its utility for hApp developers. It would be beneficial to include examples demonstrating how records/ links are created, updated, deleted, and read using methods like create_entry, get, get_details, delete_link, create_link etc.

What do you think?

Comment on lines 13 to 18
* The **agent ID** of the author
* A timestamp
* The type of action
* The hash of the previous action in the author's history of state changes, called their **source chain** (note: the first action in their chain doesn't contain this)
* The index of the action in the author's source chain
* The **weight** of the action, which is a calculation of the cost of storing the action and can be used for rate limiting
Copy link

@c12i c12i Apr 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think adding a link to the docs for each method call they can use to get the respective action data would be very helpful

Here is the ref if I am not mistaken: https://github.com/holochain/holochain/blob/develop/crates/holochain_integrity_types/src/action.rs#L234

@pdaoust
Copy link
Collaborator Author

pdaoust commented Apr 23, 2024

@c12i

However, I believe adding some code examples would significantly enhance its utility for hApp developers.

Yes, absolutely. This page is just for the overview, then other pages like Entries will have examples of using those functions. I ought to link more to them from this page though.

@c12i
Copy link

c12i commented Apr 24, 2024

I ought to link more to them from this page though.

Fair enough, the links should suffice then

@pdaoust pdaoust marked this pull request as ready for review May 24, 2024 21:41
@pdaoust pdaoust merged commit 3384968 into main May 24, 2024
6 checks passed
@pdaoust pdaoust deleted the feat/guide/working-with-data branch May 24, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants