Are there any examples of how to use this package?

Open
#6 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the existing documentation, which currently provides signatures but no usage examples. Add clear examples showing how to use the package for remote shell (SSH) sessions from Racket, and consider the work done when new users can follow the documentation to perform that task.

Written by the indexing model from the issue text.

Description

The docs only seem to have signatures. It would be helpful for new people to be able to use this to run remote shell (ssh) sessions from within racket. Can these examples be added to the documentation?

Dominant language
Racket
Stars
10
Forks
10
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from racket/remote-shell

All issues in racket/remote-shell

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.