Skip to content
AWS Amplify Documentation
Branch: master
Clone or download
Pull request Compare This branch is 69 commits behind aws-amplify:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github/ISSUE_TEMPLATE
_includes
android
cli
images
ios
js
theme
.gitignore
.spelling
404.md
Gemfile
Gemfile.lock
Readme.md
_config.yml
browserconfig.xml
index.md
manifest.json
package-lock.json
package.json
sw.js

Readme.md

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
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.