Skip to content

Commit 918bd8c

Browse files
committed
docs(README): Add instructions about preview docs
1 parent e2c45cd commit 918bd8c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Both of these test environments are setup to deal with Babel and code transpilin
4646
Code is documented using JSDoc 3, and reference documentation is published automatically with each new version.
4747

4848
- `npm run docs:watch` watches code directory, and rebuilds documentation when anything changes. Useful for documentation writing and development.
49-
- `npm run docs:dev` builds code and builds docs afterwards. Used by `npm run docs:watch`. Code building is required as the documentation is generated from the unminified ES5 compiled sources, rather than the original ES6 sources.
49+
- `npm run docs:dev` builds code and builds docs afterwards. Used by `npm run docs:watch`. Code building is required as the documentation is generated from the unminified ES5 compiled sources, rather than the original ES6 sources. You should then open the generated `out/contentful/index.html` in your browser.
5050
- `npm run docs:build` builds documentation.
5151
- `npm run docs:publish` builds documentation and publishes it to github pages.
5252

0 commit comments

Comments
 (0)