Skip to content

docs: Revive 0.35 examples #121

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

Merged
merged 8 commits into from
Jul 24, 2025
Merged

docs: Revive 0.35 examples #121

merged 8 commits into from
Jul 24, 2025

Conversation

rklaehn
Copy link
Collaborator

@rklaehn rklaehn commented Jul 23, 2025

Description

Add back the examples that were removed when moving from 0.35 to 0.9x.

Breaking Changes

None

Notes & open questions

How much should we bikeshed the progress reporting in the examples, using console and indicatif crates? On the one hand it is nice, on the other hand it makes the examples more complex.

I think we might put basic progress display for import, download and export into the util crate. But I think it would be nice if we could get by without the --features exampes feature flag for most or all examples, so maybe not use console and indicatif so we don't have to have it as dev dependencies.

I changed the transfer example to use clap like the other examples. I hope you don't mind, @matheus23.

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

Implements #120
Implements #117

rklaehn added 2 commits July 23, 2025 12:17
A few changes:

- client side is not creating a router
- allow specifying secret key
- don't publish discovery info for client
changes:
- client does not create a router
- removed progress for now
Copy link

github-actions bot commented Jul 23, 2025

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh-blobs/pr/121/docs/iroh_blobs/

Last updated: 2025-07-24T08:05:42Z

@n0bot n0bot bot added this to iroh Jul 23, 2025
@github-project-automation github-project-automation bot moved this to 🏗 In progress in iroh Jul 23, 2025
@rklaehn rklaehn marked this pull request as ready for review July 23, 2025 13:22
@rklaehn rklaehn requested review from Frando and matheus23 and removed request for Frando July 24, 2025 07:14
I think it is nice if you can use the examples without the
--features examples feature flag.
Copy link
Member

@matheus23 matheus23 left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

We can discuss the more... "controversial to me" changes to the transfer example in another PR 😬

@rklaehn rklaehn merged commit 73ca073 into main Jul 24, 2025
24 checks passed
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in iroh Jul 24, 2025
@matheus23 matheus23 deleted the revive-0.35-examples branch July 24, 2025 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants