Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an announcement for old website and link to FAQ #142

Closed
QuinnHe opened this issue Jun 27, 2024 · 7 comments
Closed

Add an announcement for old website and link to FAQ #142

QuinnHe opened this issue Jun 27, 2024 · 7 comments

Comments

@QuinnHe
Copy link
Collaborator

QuinnHe commented Jun 27, 2024

FAQ talking about older website: https://docs.ml5js.org/#/welcome/faq?id=what-happened-to-older-ml5js-releases

@shiffman
Copy link
Member

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 [email protected]. 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/[email protected]/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/[email protected]/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.

@shiffman
Copy link
Member

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

@QuinnHe
Copy link
Collaborator Author

QuinnHe commented Jul 16, 2024

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

@MOQN
Copy link
Member

MOQN commented Jul 16, 2024

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

@QuinnHe
Copy link
Collaborator Author

QuinnHe commented Jul 25, 2024

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

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

@MOQN
Copy link
Member

MOQN commented Jul 25, 2024

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

@QuinnHe
Copy link
Collaborator Author

QuinnHe commented Jul 25, 2024

Everything is updated. Close the issue.

@QuinnHe QuinnHe closed this as completed Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants