hyperledger-labs / hyperledger-labs/perun-doc

Make a glossary of terms used in dst project

Open
#10 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
8
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Several terms like "[OffChain ID](https://github.com/direct-state-transfer/dst-go/blob/5cf83f46971aaa17ba8243bcaf7a6dea5922a4ef/identity/manager.go#L33)", "[OnChain ID](https://github.com/direct-state-transfer/dst-go/blob/5cf83f46971aaa17ba8243bcaf7a6dea5922a4ef/identity/manager.go#L34)", "[Session ID](https://github.com/direct-state-transfer/dst-go/blob/5cf83f46971aaa17ba8243bcaf7a6dea5922a4ef/channel/offchain_primitives.go#L35)", "[Sender Role](https://github.com/direct-state-transfer/dst-go/blob/5cf83f46971aaa17ba8243bcaf7a6dea5922a4ef/channel/manager.go#L37)", "[Receiver Role](https://github.com/direct-state-transfer/dst-go/blob/5cf83f46971aaa17ba8243bcaf7a6dea5922a4ef/channel/manager.go#L41)" etc., are used in the code base of direct state transfer project and also referenced in the documentation.

A glossary can be created to consolidate such project specific terms and their meanings / interpretations.

Contributor guide

Open the contributing guide

Research direction

Start with the linked definitions in identity/manager.go, channel/offchain_primitives.go, and channel/manager.go, then search the documentation for other project-specific terms. Create a glossary that explains the referenced IDs and roles, along with other recurring terms, and ensure the meanings match their usage in the code and documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.