bitcoin-dev-project / bitcoin-dev-project/sim-ln

docs: Improve Crate Documentation

Open
#205 4 comments 0 reactions 1 assignee Assigned to @sangbida View on GitHub
feature Low Priority
Dominant language
Rust
Stars
80
Forks
40
Avg merge
18h 49m
Merged PRs (30d)
2

Description

`simln-lib` is a [crate](https://crates.io/crates/simln-lib) now 🎉
But it's quite an unfriendly one (not- 🎉 ) becuase we're missing a few docs.

There are a few low-hanging fruit that we could address to fix this up.

### Add a Readme
Screenshot 2024-11-20 at 13 21 04

### Better documentation for exported structs / enums
Screenshot 2024-11-20 at 13 21 15

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.