use p5js for docs - Githubissues

AvinZarlez / processing-vscode

A Visual Studio Code extension for the programming language Processing

https://marketplace.visualstudio.com/items?itemName=Tobiah.language-pde

MIT License

177 stars 25 forks source link

use p5js for docs #70

Closed brianmcfadden closed 5 years ago

brianmcfadden commented 5 years ago

IMO, p5js shows better docs than the google search, and the p5js url used here will go straight to the docs instead of having google as an intermediary. Is this change cool with you?

AvinZarlez commented 5 years ago

The p5js docs do seem to be good. But I don't know if it has Processing's blessing as "official" documentation?

Doesn't seem like a hard fix to enhance this a bit further and make it so people have the option they can set in the settings for which website they'd like to search.

I also have to do some work to figure out why the build is failing for my autodeployment, so may take me a bit to get that ready since I don't have a lot of free coding time.

To Do for this:

[x] Prework: Fix deployment/remote builds (Potentially switch from Travis to new GitHub Actions?)
[x] Add setting for which website to search
[x] Add instructions in ReadMe for adjusting said setting
[x] Add code to check setting and load appropriate site during search
[x] Test

brianmcfadden commented 5 years ago

OK, so I did the easy parts:

[ ] Add setting for which website to search
[ ] Add code to check setting and load appropriate site during search

.. and a little bit of

[ ] Test

The ReadMe should be easy, but no guarantees on the deployment problems. You might be on your own on that one.

AvinZarlez commented 5 years ago

I merged your code into my Update-1.4 branch.

However, I also changed a few things:

I appreciate that you want to add more flexibility, but I don't think we need to bog down the user with so many settings. Could end up being very confusing, and bug prone!
I think unlikely people want more than the two. If so, can add "other" feature again later
Your search URL is not quite right. Using google is nice because of fuzzy matching, same reason I use it for processsing.org

Thanks for your help / contributions!!! I'm finishing up 1.4 update now.

Closing this PR, as I merged this code already in my other branch.