Documentation for the validstate package
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
lib
public
test
vendor
.babelrc
.gitignore
.postcssrc.yml
.ruby-version
Gemfile
Gemfile.lock
LICENSE
Procfile.dev
README.md
Rakefile
config.ru
package-lock.json
package.json
yarn.lock

README.md

Validstate Documentation Site

This is the code base for the documentation of the Validstate package.

Please note: This repo does not contain the source code for Validstate only the documentation site.

Contributing

If you would like to contribute to the documentation because you have make a change to the Validstate repo or would like to fix an issue with the site here are the steps.

Prerequisits

This is a Ruby on Rails application if you are not familiar with Rails projects checkout Getting Started with Rails.

Please ensure you have the correct version of Ruby installed, as well as the bundler, and foremen gems.

Running the application locally

  1. Fork the repository and create your branch from master.
  2. Clone your fork to your machine
  3. Run bundle install
  4. Run npm install
  5. Run foreman start -f Procfile.dev

Submitting a Pull Request

The code maintainers are monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. We’ll do our best to provide updates and feedback throughout the process.

Bugs

Bugs for this documentation are tracked using Github Issues. You can find all currently open issues there.

When reporting a new issue please be as detailed as possible.