ml5js / ml5-website-archive

ml5 website!
https://archive-docs.ml5js.org
MIT License
46 stars 47 forks source link

Replace website version details with a badge #149

Closed bomanimc closed 4 years ago

bomanimc commented 4 years ago

PR Details

What kind of change does this PR introduce?

This PR introduces changes to represent the version of ML5 using a badge from Shields.io (see all templates here) instead of a hardcoded version number. This helps make it easier to release new versions of the library because we no longer need to manually update the website after every release.

Typically, the process for updating the version would be to:

After these changes are merged, no steps will be required to update the website!

The tradeoff here is that we no longer show the most recent release date because Shields.io, unfortunately, doesn't handle versions for NPM releases. We could set this up later if we ever support GitHub release, though (see GitHub templates here).

Does this PR introduce a breaking change? Nope! Though there are some cleanup changes included in this PR to remove unused fields.

What needs to be documented once your changes are merged? I don't believe that there are any necessary documentation changes.

Images

Before Screen Shot 2020-03-03 at 4 03 15 PM

After Screen Shot 2020-03-03 at 4 03 55 PM

joeyklee commented 4 years ago

Approved on my side! Merge when ready!