search

getify / You-Dont-Know-JS

A book series on JavaScript. @YDKJS on twitter.
Other
178.28k stars 33.42k forks source link

make books interactive #1686

Closed HansUXdev closed 3 years ago

HansUXdev commented 3 years ago

Yes, I promise I've read the Contributions Guidelines (please feel free to remove this line).

Specifically quoting these guidelines regarding typos:

Typos?

Please don't worry about minor text typos. These will almost certainly be caught during the editing process.

If you're going to submit a PR for typo fixes, please be measured in doing so by collecting several small changes into a single PR (in separate commits). Or, just don't even worry about them for now, because we'll get to them later. I promise.

Please type "I already searched for this issue": I already searched for this issue Edition: (pull requests not accepted for previous editions) any Book Title: any & all Chapter: any & all Section Title: any & all Topic: any & all

It just allows people to use gitpod on the repo with preinstalled extensions that you as an author to give guided codetours, pair programming with codetogether, etc. The hope is to make your content more interactive. I hope you try it out with an open mind 😄

getify commented 3 years ago

I hope you try it out with an open mind

You didn't really provide any context, so how could I have an open mind? I've never heard of gitpod, so I haven't the faintest clue what you're asking me to enable. And the diff isn't clear either. Adding a random .yml file without any context is not on my priority list.

I googled gitpod, seems like it lets you make docker images from github repos. But still, that doesn't explain at all how you're proposing that this would make this repo "more interactive"? Moreover, being "interactive" is not particularly a goal of this repo.

I'm confused as to what I'm supposed to think of this contribution?

HansUXdev commented 3 years ago

Sorry. Here is an example. It will allow people to read your book in a cloud IDE and run the code you are writing about. But I get that the book is not optimized for reading experience, per the CONTRIBUTING.md []()

getify commented 3 years ago

Appreciate the screencapture illustrating what you're referring to. I don't think that's a broadly applicable enough experience to roll into the main repo, but that's a perfect example of something you can do when you fork the repo and want to customize your experience.