cmdruid / cmdruid/regtest-workbench

Need better documentation of all the things!

Open
#11 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Shell
Stars
16
Forks
2
PR merge metrics
No merged PRs in 30d

Description

This includes better documentation for the following subjects:
* Setting up a basic environment for web development.
* Setting up a basic environment for developing core lightning plugins.
* Using the spawn command to spin up entire networks at once (similar to docker-compose)
* Using devmode to actively develop the codebase.
* Common tips and tricks for navigating and using the workbench.

Lot's of work to do!

Contributor guide

No contributing guide indexed for this repository

Research direction

No files, tests, or documentation entry points are named. Start by locating the existing documentation and the commands or entry points for environment setup, spawn, devmode, and workbench usage; the work is done when all five listed subjects have clear, usable guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, shell
Domain
developer-experience, devops, documentation, tooling, web-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.