/saasquatch-docs

📖 Referral SaaSquatch public documentation

Primary LanguageHTMLApache License 2.0Apache-2.0

Referral SaaSquatch Documentation

Build Status Dependency Status

We decided to make the Referral SaaSquatch documentation site an open source project so that we could get help from all of the lovely people out there. Contributing is easy because the documentation is either vanilla HTML or Markdown.

Contributing

The site is a simple Metalsmith static site hosted on Firebase.

To contribute:

  1. Clone this repo
  2. Add or edit an article in the src folder
  3. Run yarn install followed by yarn run local to run locally and verify your changes
  4. Submit a pull request to the staging branch.

We'll roll in changes once the Travis CI build passes and someone finishes code review.