/docs

Amplify Framework Documentation

Primary LanguageHTMLApache License 2.0Apache-2.0

Amplify Framework Documentation

CircleCI

This is the main documentation repository for the Amplify Framework. The documentation is new. We welcome feedback and contributions. Get Started >>

Contributing

The documentation is tested for spelling errors in CircleCI and against a custom dictionary .spelling. Add the words here e.g. service names etc. that should be bypassed by the checker. The spelling is checked via the npm test command during the build. You can see failing builds / errors by clicking on the build badge above. There is also a grammar check that should be run locally via npm run grammar.

Prerequisites

  • Node.js 8.x or greater: check with node --version
  • NPM or Yarn: check with npm --version or yarn --version
  • Ruby and Bundler: bundle --version

Step-by-step

When contributing to documentation:

  1. Fork this repository git clone git@github.com:aws-amplify/docs
  2. Install all the dependencies
  3. yarn install (or npm install)
  4. bundle install
  5. Make your changes and verify them locally with yarn start (or npm start)
  6. Run npm run build locally prior to creating a pull request
  7. Fix any spelling/grammar issues and update .spelling as needed
  8. Create a Pull Request here