enzymejs / enzymejs/enzyme

'Building Docs' wouldn't work naturally as 'contributing' docs described

Open
#1,906 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
19.8k
Forks
2k
PR merge metrics
No merged PRs in 30d

Description

Hi, I'm a new contributor here, and I found that the `docs` section in CONTRIBUTING.md may not work.

### Current behavior
After running `npm install`, running `npm run docs:watch` would report error, as the screenshot:
![image](https://user-images.githubusercontent.com/3454734/48554518-98188c80-e919-11e8-9a74-d0750380a7c4.png)

### Expected behavior
Run gitbook in local environment as expected.

### Your environment
node v8.1.3, npm v6.2.0

I found the solution at issue in gitbook: https://github.com/GitbookIO/gitbook/issues/1818, after going into my local `~/.gitbook/versions/3.2.2` directory and run `npm install` command, things can work now.
![image](https://user-images.githubusercontent.com/3454734/48554672-fe051400-e919-11e8-990f-e33a77ba462b.png)

That's tricky. It may be caused by the issue from gitbook, however this section of CONTRIBUTING docs just doesn't work as expected.

Contributor guide

Open the contributing guide

Research direction

Start with the docs section in CONTRIBUTING.md and run npm install followed by npm run docs:watch to reproduce the reported GitBook failure. Compare the local GitBook version under ~/.gitbook/versions/3.2.2 with GitBook issue 1818; the work is done when the documented setup runs successfully in a fresh local environment.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.