audit our examples #1929
Comments
|
where i today need use |
|
Stated in the README.md |
|
for we should:
for the listen command:
for the connect command:
However, if we are supposed to show that we can magically connect via just node id, we need to add default edit: |
|
if no besides node-id , addr , maybe a ticket with |
if the examples are there to educate someone about what so I'm not sure I would want to hide these here. For any example in the just an opinion ¯_(ツ)_/¯ not married to it |
|
i am in favor of dynamic derps in calling-cards and tickets so its like if You don't need it You have it ... |
|
@b5 i can not find |
|
@b5 but there is a `/iroh/examples/rpc.rs that i can not get to work ... " |
|
https://iroh.computer/docs/quickstart when try start node B per documentation no joy configuration option flag maybe reference version in documentation´s i see there is auto for 0.12.0 but how to start console for node B port ? need run node B on other ip for example |
|
my comment so far is code is very clean but documentation for version examples ++ is lagging. |
|
TODO:
|
ramfox
added
docs
## Description Fixes incorrect information in our `iroh/examples` Also adds an example that shows the most basic way to use iroh to fetch content. related to #1929 ## Notes & open questions Unfortunately, we don't seem to have very simple APIs for fetching (that isn't just exporting the content to an external path). Working through this. Also adds: - `BlobDownloadProgress` - this takes a stream of `DownloadProgress` and puts it into a form that will poll the stream by calling `finish` - adjusts the `blob_download0` function to not eat certain errors ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant.
## Description closes #1929 ### `provide-bytes` This example adds either a single blob or collection to the database and provides it. It gives instructions on how to run the fetch side of the example for `fetch-fsm` and `fetch-stream`. We could make this example more "advanced" by having the user provide a path & serve the blob or collection of that content, but I wanted to keep its simple at first. ### `fetch-fsm` This example fetches a blob or collection using the `get` finite state machine directly, printing the contents to the terminal. ### `fetch-stream` This example fetches a blob or collection using a helper function to turn the `get` finite state machine into a stream. It prints the contents to the terminal. ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant. - [ ] Tests if relevant.
## Description Fixes incorrect information in our `iroh/examples` Also adds an example that shows the most basic way to use iroh to fetch content. related to n0-computer#1929 ## Notes & open questions Unfortunately, we don't seem to have very simple APIs for fetching (that isn't just exporting the content to an external path). Working through this. Also adds: - `BlobDownloadProgress` - this takes a stream of `DownloadProgress` and puts it into a form that will poll the stream by calling `finish` - adjusts the `blob_download0` function to not eat certain errors ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant.
## Description closes n0-computer#1929 ### `provide-bytes` This example adds either a single blob or collection to the database and provides it. It gives instructions on how to run the fetch side of the example for `fetch-fsm` and `fetch-stream`. We could make this example more "advanced" by having the user provide a path & serve the blob or collection of that content, but I wanted to keep its simple at first. ### `fetch-fsm` This example fetches a blob or collection using the `get` finite state machine directly, printing the contents to the terminal. ### `fetch-stream` This example fetches a blob or collection using a helper function to turn the `get` finite state machine into a stream. It prints the contents to the terminal. ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant. - [ ] Tests if relevant.
## Description closes #1929 ### `provide-bytes` This example adds either a single blob or collection to the database and provides it. It gives instructions on how to run the fetch side of the example for `fetch-fsm` and `fetch-stream`. We could make this example more "advanced" by having the user provide a path & serve the blob or collection of that content, but I wanted to keep its simple at first. ### `fetch-fsm` This example fetches a blob or collection using the `get` finite state machine directly, printing the contents to the terminal. ### `fetch-stream` This example fetches a blob or collection using a helper function to turn the `get` finite state machine into a stream. It prints the contents to the terminal. ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant. - [ ] Tests if relevant.
a user on our discord has pointed out that our examples need a cleanup to match recent changes. We should do an audit of examples & make sure they're up to date by confirming each example works as described.
/iroh/examples/client.rs/iroh/examples/collection.rs/iroh/examples/dump-blob-fsm.rs/iroh/examples/hello-world.rs/iroh/examples/stream.rs/iroh-net/examples/magic.rs/iroh-gossip/examples/chat.rsThe text was updated successfully, but these errors were encountered: