Skip to content

Latest commit

 

History

History
16 lines (10 loc) · 1.16 KB

Readme.md

File metadata and controls

16 lines (10 loc) · 1.16 KB
Raw

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.

When contributing to documentation:

  1. Fork this repository git clone git@github.com:aws-amplify/docs
  2. Make your changes and run npm test and npm run grammar locally prior to creating a pull request
  3. Fix any spelling/grammar issues and update .spelling as needed
  4. Create a Pull Request here