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.

Sign up for GitHub

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

Jump to bottom

iroh-net: Docs should point to iroh #3075

Open
flub opened this issue Dec 26, 2024 · 1 comment
Open

iroh-net: Docs should point to iroh #3075

flub opened this issue Dec 26, 2024 · 1 comment
Labels
c-iroh docs Improvements or additions to documentation
Milestone
v0.31.0

Comments

@flub
Copy link
Contributor

flub commented Dec 26, 2024

If you look at https://crates.io/crates/iroh-net or https://docs.rs/iroh-net/latest/iroh_net/ there is no indication that the crate is discontinued and that the iroh crate should be used. We should probably do a point release with a warning in the README and toplevel crate docs.
@flub flub added docs Improvements or additions to documentation c-iroh labels Dec 26, 2024
@flub flub added this to the v0.31.0 milestone Dec 26, 2024
@flub flub added this to iroh Dec 26, 2024
@samuel-jimenez
Copy link

https://www.dumbpipe.dev/ needs attention as well.

@flub flub mentioned this issue Jan 10, 2025
Merged
4 tasks
flub added a commit that referenced this issue Jan 22, 2025
@flub
feat(iroh-net): add deprecation notice, bump to 0.28.2 (#3116)
31b270d 
## Description

Too many users are finding this crate and trying to use it. Make it
obvious where they should be looking instead.

Closes #3075.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

- This targets the new `maint-0.28` branch which starts off the
`v0.28.1` tag.
- Only the iroh-net crate has a new version number, I believe only
publishing this crate makes the most sense.

## Change checklist

- [x] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [x] Tests if relevant.
- [x] All breaking changes documented.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c-iroh docs Improvements or additions to documentation
Projects
iroh
Status: No status
Milestone
v0.31.0
Development

No branches or pull requests
2 participants
@flub @samuel-jimenez