ml5js/ml5-website-v02-docsify

Add an announcement for old website and link to FAQ

QuinnHe opened this issue · 7 comments

shiffman commented

This is fantastic! I think it would be nice to add a bit more info about how it works to reference the different versions. Here are some ideas, I can open a PR if this sounds good to you?

If your existing code references @latest, you may encounter compatibility issues with newer versions of ml5.js. For older code, navigate to index.html in the p5.js web editor (or whatever code editor you are using) and adjust the scirpt tag to reference ml5@0.12.2. If you were using an even older version, replace 0.12.2 with the version number you were previously using.

   <script src="https://unpkg.com/ml5@0.12.2/dist/ml5.min.js"></script>

For using the latest release of ml5.js with the new, updated models and API, you can reference 1.0.1.

   <script src="https://unpkg.com/ml5@1.0.1/dist/ml5.min.js"></script>

You can also use ml5@1 which will automatically load future 1.x releases, but this could possibly introduce things that would alter the behavior of your sketch.

  • 👍1
shiffman commented

I created this pinned issue (thanks for the draft text @ziyuan-linn!), shall we reproduce the text in the FAQ on the site? ml5js/ml5-next-gen#167

  • 👍1
QuinnHe commented

Thanks Dan @shiffman ! Yes, will work on a PR before our next regroup. cc @MOQN

  • 👀1
MOQN commented

Yes!! It will be applied by the next group meeting.

QuinnHe commented

Updates: modified the FAQ page to reflect Dan's text here

Todo: add an announcement to link to the FAQ cc @MOQN @alanvww

  • ❤️1
MOQN commented

Update: Announcement banner was added to the main page, and linked to the FAQ.

  • ❤️1
QuinnHe commented

Everything is updated. Close the issue.

  • 🚀1