This is the main documentation repository for the Amplify Framework. The documentation is new. We welcome feedback and contributions. Get Started >>
We just launched a preview of our new docs site. Check it out at https://docs.amplify.aws ๐
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
.
- Node.js
10.x
or greater: check withnode --version
- NPM or Yarn: check with
npm --version
oryarn --version
- Ruby and Bundler:
bundle --version
When contributing to documentation:
- Fork this repository
git clone [email protected]:aws-amplify/docs
- Install all the dependencies
yarn install
(ornpm install
)bundle install
- Make your changes and verify them locally with
yarn start
(ornpm start
) - Run
npm run build
locally prior to creating a pull request - Fix any spelling/grammar issues and update
.spelling
as needed. - Create a Pull Request here