Browse Source

update docs

Steven Silvester 7 years ago
parent
commit
7a7b14b2ba
2 changed files with 5 additions and 5 deletions
  1. 3 3
      CONTRIBUTING.md
  2. 2 2
      docs/repo.md

+ 3 - 3
CONTRIBUTING.md

@@ -198,14 +198,14 @@ jupyter lab --dev-mode --watch
 ```
 
 
-## Helper Scripts
+## Build Utilities
 
-There are a series of helper scripts for maintaining the repository.
+There are a series of build utilities for maintaining the repository.
 To get a suggested version for a library use `npm run get:dependency foo`.
 To update the version of a library across the repo us `npm run update:dependency foo@^x.x`.
 To remove an unwanted dependency use `npm run remove:dependency foo`.
 
-The key helper script is `npm run integrity`, which ensures the integrity of 
+The key utility is `npm run integrity`, which ensures the integrity of 
 the packages in the repo. It will:
 
 - Ensure the core package version dependencies match everywhere.

+ 2 - 2
docs/repo.md

@@ -12,13 +12,13 @@ See the [Contributing Guidelines](https://github.com/jupyterlab/jupyterlab/blob/
 
 ## Directories
 
-### NPM package: `src/`, `lib/`, `typings/`, `scripts/`
+### NPM package: `src/`, `lib/`, `typings/`, `buildutils`
 
 * `src/`: the source typescript files.
     - `npm run build` builds the source files into javascript files in `lib/`.
     - `npm run clean` deletes the `lib/` directory.
 * `typings/`: type definitions for external libraries that typescript needs.
-* `scripts/`: various scripts that the npm commands invoke.
+* `buildutils/`: Utilities for managing the repo
 
 ### Examples: `examples/`