VeryGoodOpenSource / very_good_docs_site

A Very Good Documentation Site created by the Very Good Ventures Team ๐Ÿฆ„
https://brickhub.dev/bricks/very_good_docs_site
MIT License
15 stars 1 forks source link

feat: update to docusaurs 3.0 #152

Closed tomarra closed 10 months ago

tomarra commented 11 months ago

Status

In Development

Description

With Docusaurs 3.0 out now, updating our template to use the newest version. This is going to need a decent amount of testing but overall it seems to be up and running without much issue.

Fixes #134

Type of Change

alestiago commented 10 months ago

I cloned the directory and generated a documentation site with the new brick.

I got 3 deprecation warnings:

npm WARN deprecated stable@0.1.8: Modern JS already guarantees Array#sort() is a stable sort, so this library is deprecated. See the compatibility table on MDN: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#browser_compatibility
npm WARN deprecated @babel/plugin-proposal-object-rest-spread@7.12.1: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
npm WARN deprecated trim@0.0.1: Use String.prototype.trim() instead

And I got 22 vulnerabilities:

added 1239 packages, and audited 1240 packages in 1m

219 packages are looking for funding
  run `npm fund` for details

22 vulnerabilities (4 moderate, 18 high)

To address issues that do not require attention, run:
  npm audit fix

To address all issues (including breaking changes), run:
  npm audit fix --force

I was able to build (npm run build) and serve (npm run serve) the website without any problem .

I'm happy with merging as is but if so, we should follow-up with a Pull Requests fixing the deprecation and vulnerabilities.

tomarra commented 10 months ago

I got 3 deprecation warnings:

These I'm not sure if we can/should do much about but let me look

And I got 22 vulnerabilities:

Let me run the audit fix and see if we can get that a little cleaner