Add walkthrough #34
Add walkthrough #34
Conversation
shannynat
requested review from
chip-so,
djohnson-spideroak,
elagergren-spideroak,
gknopf-aranya,
jdygert-spok and
ycarmy
as code owners
| permalink: "/walkthrough/" | ||
| --- | ||
|
|
||
| # Getting Started with Aranya |
There was a problem hiding this comment.
Since this walkthrough is being moved to aranya-docs, we'll want to mention that the instructions are for the aranya repo. That used to be implied by the walkthrough being in the aranya repo. Since that's no longer the case, readers will need the additional context.
There was a problem hiding this comment.
Ok, I added a link to the aranya repo where Aranya is first mentioned, the first paragraph below this. Lmk if you think it should be more obvious
There was a problem hiding this comment.
It might help to be a little more specific by saying something about how this walkthrough uses the daemon integration of Aranya (include link to the repo) since you could then add a following sentence per Scott's comment #33 (comment) to reference where other material related to the library-only integration exists.
There was a problem hiding this comment.
Added a note that the walkthrough uses the aranya repo as a client/daemon integration (with links) and that the aranya-runtime crate can be used to integrate with aranya as a library only. Since we don't have documentation on the library-only integration, I just included a link to the runtime crate for the time being. Can add a story to link the docs when we have them.
I also rearranged the information at the top (it felt a little weird and congested having multiple notes/things to keep in mind).
There was a problem hiding this comment.
Since we do not have the documentation (or clarity on whether we want to include information on integrating directly with aranya-core) yet, removed the reference to integrating with aranya-core/runtime. I did keep the information rearranging and a note about what the walkthrough uses in the examples.
There was a problem hiding this comment.
@shannynat can this conversation be resolved?
This change updates the previously relative links to be absolute links to the open-source aranya repo. This also adds a link to that repo in the beginning of the walkthrough so users know what implementation the walkthrough is based on.
The link to the overview doc, which is also on the public docs site, was using the markdown syntax. This changes the link to use the jekyll syntax.
shannynat
force-pushed
the
33-move-walkthrough
branch
from
52c5de6 to
d04779b
Compare
The walkthrough predates the Rust template application so it only linked to the C example. This change adds links to the Rust template where the C example was linked.
The walkthrough will be moved to the public docs site. This also updates the top-level readme to link directly to the docs site. PR for adding the walkthrough to the docs site is here: aranya-project/aranya-docs#34. This PR should not be merged until that has been merged. Closes aranya-project/aranya-docs#33
This change rearranges the notes and things to keep in mind to make this information more concise. It also adds a note that the walkthrough is based on using both the aranya-daemon and aranya-client crate, with examples using the Rust API and C API wrappers.
shannynat
force-pushed
the
33-move-walkthrough
branch
from
4fbd82b to
cc89d2c
Compare
First half of moving the walkthrough from the main aranya repo to the public docs site.
PR to remove the walkthrough from aranya: aranya-project/aranya#56
Closes #33