NUKnightLab / NUKnightLab/interactive-textbook

small README edits

Open
#1 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Privilege warnings

https://github.com/NUKnightLab/interactive-textbook/blob/15b359fcb8b2659efaa9712160b6f035dd17baa0/README.md?plain=1#L20

I was also asked for privileges by Terminal and VS Code:

Image Image

old code

https://github.com/NUKnightLab/interactive-textbook/blob/15b359fcb8b2659efaa9712160b6f035dd17baa0/README.md?plain=1#L29-L31

Is there a reason not to just remove it from the repository?

early "open"

I think that the installer opened the "home page" in VS Code before it was done installing. I wasn't paying close attention, so it's possible that I opened it accidentally myself.

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

Start with README.md at the linked sections around lines 20 and 29-31, then review the installer guidance related to Terminal, VS Code privileges, and the early page opening. Done means the README's outdated or confusing instructions are clarified or removed and the installation behavior is accurately described.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.