You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributor-docs/contributing.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Please follow the steps on the [how to build guide page](#building-instui).
33
33
### Development
34
34
35
35
1. Run `npm run build:watch` to build all of the packages for a development environment and watch for changes.
36
-
1. Run `npm run dev` to start the dev server to run/develop examples and documentation. You can then visit [http://localhost:8080](http://localhost:8080) in a browser. When you make changes to the source code you should see the page auto-reload.
36
+
1. Run `npm run dev` to start the dev server to run/develop examples and documentation. You can then visit [http://localhost:9090](http://localhost:9090) in a browser. When you make changes to the source code you should see the page auto-reload.
37
37
1. Run `npm run test:watch -- --scope @instructure/[package name]` to run the tests for 'package name' and watch for changes.
38
38
1. Run `npm run test` to run all the tests for every package.
39
39
@@ -79,7 +79,7 @@ Please update the documentation and examples with any changes.
79
79
2. Add the dependency in `packages/__docs__/package.json`.
80
80
3. Add the reference in `packages/__docs__/tsconfig.build.json`.
81
81
6. Stop the dev server (if you have it running), and run `npm run dev` to pick up the new package.
82
-
7. Visit [http://localhost:8080](http://localhost:8080) in a browser. You should see your package listed in the docs.
82
+
7. Visit [http://localhost:9090](http://localhost:9090) in a browser. You should see your package listed in the docs.
83
83
84
84
### Adding a component
85
85
@@ -99,7 +99,7 @@ Please update the documentation and examples with any changes.
99
99
8. Run `npm run bootstrap` to generate the `es`, `lib` and `types` directories for your component.
100
100
9. Add your component to `packages/__docs__/components.js`.
101
101
10. Stop the dev server (if you have it running), and run `npm run dev` to pick up the new component.
102
-
11. Visit [http://localhost:8080](http://localhost:8080) in a browser. You should see your component listed in the docs.
102
+
11. Visit [http://localhost:9090](http://localhost:9090) in a browser. You should see your component listed in the docs.
103
103
12. Start making changes to your component, and watch it update in the browser automatically.
104
104
13. Resolve all `FIXME` comments in the generated code (except in the `MyComponentLocator.ts`).
|`npm run bootstrap`| Clean all node modules and build output, reinstall dependencies, create fresh build including regenerating design tokens and type declaration files. |
14
-
|`npm run dev`| Run a local instance of the documentation app in dev mode. Docs will be served at `http://0.0.0.0:8080`|
14
+
|`npm run dev`| Run a local instance of the documentation app in dev mode. Docs will be served at `http://0.0.0.0:9090`|
15
15
|`npm run start`| Run a local instance of the documentation app in production mode. The urls where the docs are being served will be included in the output of this command. |
16
16
|`npm run build`| Run the build command for all Instructure UI packages. Similar to bootstrap, but without the cleaning steps, installation of dependencies, and without the token and type generation. |
17
17
|`npm run build:watch`| Identical to `npm run build` but will watch for changes. Note: this command is rarely necessary to use. If you are running `npm run dev`, the docs app will already be watching for any changes for components. |
0 commit comments