Contribute Documentation
Documentation is the starting point for developers to learn how to build successful websites, stories, ads, and dynamic emails with AMP. The core AMP documentation team is a small one, but our responsibility is big. We appreciate your help! Contributors can fix typos, correct out of date information, and write brand new docs! Use this page to get started learning the ins and outs of becoming a documentation contributor.
Thanks for your interest in contributing to the AMP Project, welcome to the team!
Get started
amp.dev hosts our documentation and the AMP team collaborates on GitHub. Follow the amp.dev repository’s README to run amp.dev on your local machine. This is essential for ensuring correct asset rendering and formatting. However, for simple fixes such as typos, you can edit the file directly on GitHub.
Join the AMP Project Slack outreach working group and let us know what you’re working on!
There are several ways to contribute documentation to amp.dev. We’ve outlined a few to get started. If you would like to contribute in a different way, please do not hesitate to reach out and ask if we can accept it!
Good first issues
Our tiny (although mighty) team is busy hacking away our issues large and small. If you’d like to contribute but are unsure of where to start, check our issues and filter by the good first issues label. These are easy fixes that will get you familiar with amp.dev and how the contributing process works.
Editing documentation
If you see out of date, misplaced, or incorrect information, you can fix it! We welcome fixes as pull requests, but are equally appreciative if you file an issue. Bonus points if you file an issue and assign it to yourself. This tracks efforts and avoids duplicate work.
Writing documentation
Want a guide or tutorial but don’t see it on amp.dev? You can write it! Start by reviewing the types of documentation we accept and submitting a documentation proposal. Once your proposal has been accepted, get familiar with the AMP terminology guide and documentation formatting guidelines. Look here for information on contributing examples.
-