Built with Slate.

• Ensure you have Ruby 3.2.x installed
• Ensure you have Bundler installed and have run bundle install in this directory
• Ensure you have the latest version of NodeJS installed
• Get the npm dependencies: npm install
• Start the test server: npm start
• You can now see the docs at http://localhost:8000.

When you create a new file, ensure you include it in source/index.md.

JSON examples exist under source/include/api_resources, these need to be added to the top of source/index.md.

• Ordering of sections:
  • header
  • object
  • extra object info
  • create
  • get/read
  • list
  • update
  • delete
  • alphabetical everything else
• Object names should be lowercased and separated by a space
• Every object description should have examples
• Every request should have a "Permitted roles"
  • Use "All Roles" to define any set of permissions that do not apply to org/space managers, developers, etc.
• Optional params should be omitted from request examples.

From this directory:

bundle exec middleman build
cf push docs -b staticfile_buildpack -p ./build