n0-computer / n0-computer/iroh-docs

TODOs / Missing features in 0.9X vs iroh-docs 0.35:

Open
#49 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
74
Forks
16
PR merge metrics
No merged PRs in 30d

Description

  • Doc::export_file and Doc::import_file are missing. Would need some more work to port them, I didn't get around to that yet. But it's not super critical, as you can import via iroh-blobs and then use Doc::set_hash.
  • Document all the API changes (this is quite a bit of work - best way likely to compare the docs for old and new version)
  • Maybe: Convert errors to snafu. This is still using anyhow and thiserror. It is quite some work, not sure about it yet.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by separating the missing import/export APIs, API documentation comparison, and possible snafu conversion into distinct scopes, then compare the old and new API documentation as suggested. The work is done only when the selected scope is explicitly resolved and its corresponding checklist item can be closed.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.