max-mapper / max-mapper/get-dat

Consistency in referring to the terminal instances in the tutorial

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

Nobody has claimed this yet.

Dominant language
HTML
Stars
70
Forks
27
PR merge metrics
No merged PRs in 30d

Description

In https://try-dat.com/06-dat-git-partial.html, there’s initially reference to “local terminal” and then to “source terminal”. Unless I’m mistaken, these are referring to the same terminal instance. We should stick to one or the other.

Similarly, in https://try-dat.com/05-website.html, both “virtual terminal” and “source terminal” are used.

In https://try-dat.com/02-link.html, the first qualification of terminals is made as there’s a source and destination terminal. Before that point, we use the generic term “terminal”.

I’d suggest that when a distinction between terminals doesn’t need to be made, we should simply refer to “the terminal” and when it does, to consistently name and refer to them so as not to confuse readers.

Will send a basic PR in a few moments.

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.

Research direction

Review the tutorial pages 06-dat-git-partial.html, 05-website.html, and 02-link.html. Check each terminal reference and standardize the wording so generic terminals use “the terminal” and distinct source and destination terminals are named consistently; done when the terminology is consistent across all three pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.