Installation instructions cause failure to build

[tekstrand]

Project details

• Github repo: https://github.com/meshtastic/meshtastic
• Docusaurus 3.1.1

Description

I am following the steps laid out in the readme, those result in these errors Module not found: Error: Can't resolve '@grnet/docusaurus-term-preview' Module not found: Error: Can't resolve '@grnet/docusaurus-glossary-view'

so I install those w/ the package manager(pnpm in this case). One note is that with the install I am getting a peer dep warning

 WARN  Issues with peer dependencies found
.
└─┬ @grnet/docusaurus-term-preview 2.0.0-rc
  └─┬ postel 0.1.5
    ├── ✕ unmet peer react@^16.13.1: found 18.2.0
    ├── ✕ unmet peer react-dom@^16.13.1: found 18.2.0
    └── ✕ unmet peer typescript@~3.7.2: found 5.3.3

This results in Could not parse import/exports with acorn for a few files. One full log here:

[ERROR] Client bundle compiled with errors therefore further build is impossible.
Error: MDX compilation failed for file "[...]/meshtastic/docs/about/contributing.mdx"
Cause: Could not parse import/exports with acorn
Details:
{
  "cause": {
    "pos": 154,
    "loc": {
      "line": 9,
      "column": 3
    },
    "raisedAt": 54
  },
  "column": 4,
  "message": "Could not parse import/exports with acorn",
  "line": 9,
  "name": "9:4",
  "place": {
    "line": 9,
    "column": 4,
    "offset": 154
  },
  "reason": "Could not parse import/exports with acorn",
  "ruleId": "acorn",
  "source": "micromark-extension-mdxjs-esm",
  "url": "https://github.com/micromark/micromark-extension-mdxjs-esm#could-not-parse-importexports-with-acorn"
}

[tekstrand]

Issue was unrelated to this project. I do think the readme should be updated to include required installation of the other packages though.

[osterman]

@tekstrand could you share the list of all packages you needed to install? Running into the same problem.

[osterman]

Found your PR, thanks. https://github.com/meshtastic/meshtastic/pull/993