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/references nav and more content #415

Merged
merged 26 commits into from
Mar 28, 2024

Conversation

mattyg
Copy link
Member

@mattyg mattyg commented Jan 8, 2024

Overview

  • Improvements to References page:
    • standardize & modify names of sidebar links
    • add page sections navigator
    • no longer label the HDK as "HDK (Rust)" as there are currently no other HDKs available to distinguish against
    • add link to HDI and explanation text
    • add links to js & rust client docs to sidebar
    • add link to community-maintained clients (C#)
  • add link to developer immersive slides & exercises

@pdaoust I thought about linking to existing example apps (i.e. acorn, mewsfeed), and/or to existing dev agencies (dark soil, lightningrodlabs, etc.). Do either of these make sense to you?

@mattyg mattyg requested a review from pdaoust January 8, 2024 21:38
@mattyg mattyg removed the request for review from pdaoust January 8, 2024 21:46
@mattyg mattyg requested a review from pdaoust January 8, 2024 21:56
@pdaoust
Copy link
Collaborator

pdaoust commented Feb 26, 2024

Thanks for catching this -- I knew the section name was mismatched with the URL path, but didn't know it was also mismatched between top nav and sidebar nav. I'd suggest we do this, but rename it all to 'Resources', which I feel accommodates both references and the other stuff you're adding, plus non-buildy howtos. I've just asked @MatthewNichols if that goes against some empirical findings they made when they were doing usability testing. Suspect it's okay to change though.

@mattyg
Copy link
Member Author

mattyg commented Mar 4, 2024

I'd suggest we do this, but rename it all to 'Resources'

Looks like you've done this in #429 -- happy to have you merge that into this PR but lmk if you need me to.

@pdaoust
Copy link
Collaborator

pdaoust commented Mar 4, 2024

yup, I'll merge that into this once it's approved -- it's really basic but feels like it's kind of a dependency for a lot of other restructurings we want to do.


When you write a Holochain application, the part that lives in Holochain is called a [DNA](../concepts/2_application_architecture/#layers-of-the-application-stack). It runs in a WebAssembly sandbox and talks to the host, or conductor, through the host API. The Rust HDK (Holochain Development Kit) makes it easy for you to write your DNAs in the Rust programming language.
When you write a Holochain application, the part that lives in Holochain is called a [DNA](/concepts/2_application_architecture/#layers-of-the-application-stack). It runs as a guest in a WebAssembly sandbox and talks to the host, or Holochain conductor, through the host API. It's also expected to implement callbacks that the conductor needs to call at certain times. The HDK and HDI Rust crates make it easy for you write guest code that interfaces with the conductor --- the HDK for your DNA's [coordinator zomes](/resources/glossary/#coordinator-zome) and the HDI for [integrity zomes](/resources/glossary/#integrity-zome).
Copy link
Member Author

@mattyg mattyg Mar 21, 2024

Choose a reason for hiding this comment

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

I think this is TMI for this section. But lets leave it for now -- once we have a Build section it can be moved there.


For both of these APIs, you make an RPC call sending a MessagePack-serialized request to the conductor over WebSocket and listening for a response. On the interface that exposes the app API, you can also listen for [**signals**](./glossary/#signal) broadcast by cells.
For both of these APIs, you make an RPC call sending a MessagePack-serialized request in a special envelope format to the conductor over WebSocket and listen for a response. The request's envelope must contain a request ID, and the matching response will have the same ID. On the interface that exposes the app API, you can also listen for [**signals**](/resources/glossary/#signal) broadcast by cells. There are [client libraries](#conductor-clients) for JavaScript and Rust that make it easy to handle requests/responses and set up signal listeners.
Copy link
Member Author

Choose a reason for hiding this comment

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

I think this is TMI for this section. But lets leave it for now -- once we have a Build section it can be moved there.

src/pages/resources/index.md Outdated Show resolved Hide resolved
Copy link
Member Author

@mattyg mattyg left a comment

Choose a reason for hiding this comment

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

Marking this as "request changes" (since I'm not actually able to do so on my own PR)

Copy link
Member Author

@mattyg mattyg left a comment

Choose a reason for hiding this comment

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

approved

@pdaoust pdaoust merged commit ef4f91e into main Mar 28, 2024
2 checks passed
@pdaoust pdaoust deleted the feat/references-nav-and-more-content branch March 28, 2024 21:21
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.

2 participants