Skip to content

Commit

Permalink
refactor: move docs engine into iroh-docs (#2343)
Browse files Browse the repository at this point in the history
## Description

Moves `iroh::docs_engine` to `iroh_docs::engine`. Most changes are
changed imports, dependencies, and visibility changes (plus docs where
they are now required). Everything is moved over, only the RPC
implementation stays in iroh for now.

The `iroh_docs::engine::Engine` is wrapped in a newtype `DocsEngine` in
iroh that derefs to the `Engine` so that we can implement the RPC
methods directly.

## Breaking Changes

* `iroh::client::docs::{Origin, SyncReason, SyncEvent}` are now
reexports of `iroh_docs::engine::{Origin, SyncReason, SyncEvent}`. There
is no need to change anything in your code that uses these structs via
`iroh::client::docs`.

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

## Notes & open questions

<!-- Any notes, remarks or open questions you have to make about the PR.
-->

## Change checklist

- [x] Self-review.
- [x] Documentation updates if relevant.
- ~~[ ] Tests if relevant.~~
- [x] All breaking changes documented.
  • Loading branch information
Frando authored Jun 4, 2024
1 parent bc439c5 commit 68e3039
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 68e3039

Please sign in to comment.