Table of Contents generated with DocToc

• @hulu/roca
  • Documentation
  • Contributing
    • Modifying the docs site

@hulu/roca

BrightScript unit testing. No device required.

Documentation

All of our documentation is at hulu.github.io/roca. If you'd prefer to view the raw markdown that powers the doc site, it's all in the docs/ folder.

Contributing

If you spot a bug or want a feature, please feel free to file an issue. If you want to contribute code yourself, simply fork the repo and open a PR.

NPM Package Management

The package registry for this project is located at npmjs.com: @hulu/roca. Only privileged members are able to publish new updates. If you need to be granted privileges, reach out to one of the repository owners and have them add you.

Modifying the docs site

We use docsify to build our site, and Github pages to deploy it. To run the documentation site locally, simply run:

$ yarn serve-docs

Any changes you make to files in the docs/ directory will cause the server to automatically reload the page.