Skip to content
AWS Amplify Documentation
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github/ISSUE_TEMPLATE
_includes initial structure commit Sep 19, 2018
android
cli Fix typo in DataSourceName (#546) Mar 19, 2019
images Add Hosting option with AWS Amplify Console (#514) Mar 11, 2019
ios
js [JS] Fix complete new password docs (#550) Mar 18, 2019
theme tweaks: fix markup on index.html Mar 6, 2019
.gitignore
.spelling
404.md fix header links Oct 19, 2018
Gemfile Update Gemfile Sep 21, 2018
Gemfile.lock Initial GraphQL docs Oct 19, 2018
Readme.md Title change Nov 10, 2018
_config.yml
browserconfig.xml add doc theme and js guides Sep 20, 2018
index.md
manifest.json remove unused files and update manifest Sep 24, 2018
package-lock.json Adding documentation for feature #441 (#352) Feb 11, 2019
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.