arik-so / arik-so/SwiftLightning

documentation: clarify Overview

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
33
Forks
7
PR merge metrics
No merged PRs in 30d

Description

w/r/t "This guide aims to give the reader an overview of the structure of Rust Lightning functionality, as well as a reference for integrating the exported bindings in an object-oriented language using Swift as the example."

Some qs:
1) is this guide a walkthrough for how to create language bindings to Rust Lightning's exported C/C++ bindings, using Swift as the example language?
2) and/or, is this guide a walkthrough for how to create a RL node using this repo's Swift language bindings?

I'm still figuring out the answers to these questions, but I think the answers to those questions should be clarified in the opening paragraph. :)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Overview opening paragraph quoted in the issue and compare it with the surrounding documentation to determine whether it describes creating bindings, creating a node with Swift bindings, or both. Update that paragraph to answer the two questions explicitly, then verify the guide's wording matches its actual scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, cpp, rust, swift
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.