We encourage your feedback and suggestions on these documents. Content and feature suggestions and discussions are welcome via GitHub Issues. You may also propose changes to the content directly by submitting a pull request.
You don't need to install any software to suggest a change. To propose a change from your browser, select a play in the _plays folder. You can use GitHub's in-browser editor to edit files and submit a "pull request" for your changes to be merged into the document.
If you would like to see and discuss the changes that other people have proposed, visit the "Pull Requests" section and browse the issues.
The Playbook is compiled from Markdown files using Jekyll. To propose a specific change, you can submit a pull request with your change to one of these source Markdown files. The Plays from the Playbook are available in the _plays folder.
You can also use GitHub's in-browser editing feature to make an edit to one of these Markdown files and submit your change for consideration without needing to install any additional software.
To run the site locally on your own computer (most helpful for previewing your own changes), you will need to install Jekyll and other dependencies:
If you don't already have Ruby and Bundler installed, follow the first two steps in these Jekyll installation instructions.
Next, fork this repository and clone it on your computer.
Navigate to the folder on your computer, and run the command $ bundle install at the command line prompt.
To run the site locally, run jekyll serve --watch, then visit http://localhost:4000/ in your browser to preview the site.
This project uses Sass for managing its style sheets. These styles are defined in the styles.scss file. We use Jekyll's native SASS support to auto-generates the required CSS when you run the site locally, as described above.