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

Docs Docker section ./run commands seem incorrect #5199

Closed
mejutoco opened this issue Jan 15, 2024 · 1 comment
Closed

Docs Docker section ./run commands seem incorrect #5199

mejutoco opened this issue Jan 15, 2024 · 1 comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect

Comments

@mejutoco
Copy link

Description

The docs https://github.com/mermaid-js/mermaid/blob/1c43e8e15c943099ad9fd6ee2d5d480cd70327b5/CONTRIBUTING.md have a docker section about running in docker with the commands:

./run install # npx pnpm install
./run test # pnpm test

When run both of these break with

mermaid (develop) $ ./run install
./run: line 93: run: command not found

mermaid (develop) $ ./run test
./run: line 93: run: command not found

Examining the run script it seems they would run correctly with:

./run pnpm install
./run pnpm test

Steps to reproduce

  1. Run ./run install
  2. Run ./run test

Screenshots

No response

Code Sample

No response

Setup

  • Mermaid version: Latest docs
  • Browser and Version: [Chrome, Edge, Firefox]

Suggested Solutions

Documentation needs to be updated with the correct command.

Additional Context

This is my first contribution to this project. I checked on the existing issues but could not find a similar one. Please let me know if I should approach it differently.

@mejutoco mejutoco added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Jan 15, 2024
@mejutoco
Copy link
Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant