Update documentation to address broken boilerplate links #1153
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Actually, I can just add this example manually! I almost forgot about that option 😂. I'll update this PR to include the web editor link shortly. |
|
I added this sketch manually to our account (https://editor.p5js.org/ml5/sketches/qqhYX2QmN), but the URL doesn't work with our current naming convention. I'm unfortunately not sure how to give a web editor sketch a custom URL; anyone have insight on this? For now, I'll add the current link into the docs, but the link to the web editor on the examples site will remain broken for now. We should probably create a way to special-case links on the examples site so we have more flexibility, but that's something we can consider in a separate issue. |
shiffman
approved these changes
Mar 1, 2021
This was referenced Mar 5, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #718.
We've received a few different issues related to the broken boilerplate links in our site, which come from the fact that we deprecated the ml5-boilerplate repo in 2019.
This PR adds back in the boilerplate by adding them to this repo as examples, which can be viewed live on the examples site or can be shared via GitHub to see the code. For the p5.js boilerplate, we'd typically add a link to the web editor, but I'm going to follow-up to add that once we've been able to deploy an update to our examples (see processing/p5.js-web-editor#1773 for some conversation about the process for updating p5.js web editor examples).