Where it comes from

Documentation is written as YARD comments directly in the source code, compiled into Markdown via build exec rake docs:build and served by Doctocat.

Lookbook / Documentation / Demo Rails App

• Lookbook: Components can be interacted with, seen in different contexts, and controls can be manipulated
  • Runs on port 4000
  • Defined in lookbook/test/components/previews
• Docs: Generated YARD docs with examples, see components with usage instructions and examples
  • Runs on port 5300
  • To rebuild docs, run bundle exec rake docs:build

To run Lookbook, the documentation site, and the Lookbook app, run:

script/server

If you are running into issues or not seeing your updates, a few things you can try:

• Delete the overmind.sock file and run script/server again
• Ensure you have run script/setup
• Delete the node_modules directory and re-run script/setup
• Run bundle exec rake docs:build
• Run bundle exec rake docs:preview

Note: Overmind is required to run script/server.