DefinedNet / nebula-docs

Documentation for the Nebula open source project
https://nebula.defined.net/docs
12 stars 10 forks source link

Upgrade to Docusaurus v3 #110

Closed jasikpark closed 9 months ago

jasikpark commented 9 months ago

https://docusaurus.io/blog/releases/3.0

netlify[bot] commented 9 months ago

Deploy Preview for nebula-docs-dn ready!

Name Link
Latest commit d17fa37bc0dd32d05cf58540e8aa4fce6f082fc1
Latest deploy log https://app.netlify.com/sites/nebula-docs-dn/deploys/65427c17fc2b73000875f7ba
Deploy Preview https://deploy-preview-110--nebula-docs-dn.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jasikpark commented 9 months ago

i'm a bit confused about why i get a type error locally:

❯ pnpm typecheck         

> nebula-docs@0.0.1 typecheck /Users/calebjasik/Git/defined.net/nebula-docs
> tsc

node_modules/@docusaurus/plugin-content-docs/src/sidebars/types.ts:228:3 - error TS2344: Type '"id" | "title" | "frontMatter" | "source" | "sourceDirName" | "sidebarPosition" | "unversionedId"' does not satisfy the constraint '"description" | "id" | "title" | "frontMatter" | "source" | "sourceDirName" | "sidebarPosition" | keyof LastUpdateData | "version" | "slug" | "permalink" | "draft" | "unlisted" | "editUrl" | "tags"'.
  Type '"unversionedId"' is not assignable to type '"description" | "id" | "title" | "frontMatter" | "source" | "sourceDirName" | "sidebarPosition" | keyof LastUpdateData | "version" | "slug" | "permalink" | "draft" | "unlisted" | "editUrl" | "tags"'.

228   | 'id'
      ~~~~~~
229   | 'unversionedId'
    ~~~~~~~~~~~~~~~~~~~
... 
233   | 'sourceDirName'
    ~~~~~~~~~~~~~~~~~~~
234   | 'sidebarPosition'
    ~~~~~~~~~~~~~~~~~~~~~

Found 1 error in node_modules/@docusaurus/plugin-content-docs/src/sidebars/types.ts:228

 ELIFECYCLE  Command failed with exit code 2.

but not in CI? not worried about it though, since it's visually fine. just something to sort if it's a problem.