Framework documentation
===

Documentation is autogenerated from typescript files in [../src/api](/bright-js-framework/tree/master/src/api). The documentation site is built using [gatsby](https://gatsbyjs.org) and deployed on merge to master. API documentation is generated from headers using [typedoc](http://typedoc.org).

Pull requests must include documentation for new or updated APIs. This may consist of either header-docs or high-level conceptual documentation in [./src/docs](/bright-js-framework/tree/master/docs-site/src/docs).

To work on the documentation site, you'll first need to install its development dependencies:

```
gulp site:bootstrap
```

After this, you can run the project site in development mode using:

```
gulp site:watch
```

Note that you'll need to exit and restart this task if you want to reflect any updated API docs.

Important sources:
--

Module documentation: [./src/templates/ModuleDoc.js](/bright-js-framework/blob/master/docs-site/src/templates/ModuleDoc.js)
High-level doc pages: [./src/pages/docs/](/bright-js-framework/blob/master/docs-site/src/templates/ModuleDoc.js)

Framework documentation
===

Documentation is autogenerated from typescript files in [../src/api](/bright-js-framework/tree/master/src/api). The documentation site is built using [gatsby](https://gatsbyjs.org) and deployed on merge to master. API documentation is generated from headers using [typedoc](http://typedoc.org).

Pull requests must include documentation for new or updated APIs. This may consist of either header-docs or high-level conceptual documentation in [./src/docs](/bright-js-framework/tree/master/docs-site/src/docs).

To work on the documentation site, you'll first need to install its development dependencies:

```
gulp bootstrap
```

After this, you can run the project site in development mode using:

```
gulp site:watch
```

Note that you'll need to exit and restart this task if you want to reflect any updated API docs.

Important sources:
--

Module documentation: [./src/templates/ModuleDoc.js](/bright-js-framework/blob/master/docs-site/src/templates/ModuleDoc.js)
High-level doc pages: [./src/pages/docs/](/bright-js-framework/blob/master/docs-site/src/templates/ModuleDoc.js)

Update readme to reflect docsite changes
Update readme to reflect docsite changes
