n0-computer/iroh-examples

Expand Example Expalanations

Open

#92 opened on Sep 24, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (38 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (196 stars)
PR merge metrics
 (PR metrics pending)

Description

The example list is basically one sentence per example and may not be the clearest example of what each is an example of. I would propose it have something like:

Example

Explanation of example.

Features Example Illustrates

  • feature 1
  • feature n

Also it would be good if all examples had hyperlinks to the projects. Some do, some do not.

Contributor guide

Research direction
Review existing examples and identify which ones lack explanations or hyperlinks. Then rewrite each example to include a clear description and list of features illustrated, ensuring all have working links to the projects.
Tech stack
rust
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
MarkdownGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90