manojchawda / amplitude-dev-center

Amplitude's Developer Center docs.

README

This is the repo for the Amplitude developer docs site.

We use Material for MkDocs to create our docs.

If you have any questions, comments, or concerns open an issue.

Contribute

Anyone can suggest changes to the docs. Just open a PR with your changes! See our contribution guide to get started.

Getting Started

📌 This is an abbreviated version of the install instructions. For a full walkthrough that includes optional steps to create the best contributor experience, check out the Amplitude Developer Center Wiki

Before you can install, you need pip. To install the link checker and Vale locally, you need brew and npm too.

1. Install Material. This command installs almost every dependency.

   pip install mkdocs-material

2. Install the git revision plugin

   pip install mkdocs-git-revision-date-plugin

3. (Optional) Install Vale and markdown-link-check. See the Wiki for full details.

4. Get the repo.

   • Ampliteers: clone the repo: git clone https://github.com/Amplitude-Developer-Docs/amplitude-dev-center.git. If you aren't on the team, request access in #dev-doc-requests.
   • Everyone else: Fork the repo.

5. Preview changes locally using mkdocs serve

6. When you're ready, open a PR against main. Fill out the pull request template the best you can.

7. Check your PR preview build. The bot will add a PR comment with the link.

8. Merge. After your PR is approved, you can merge it if you have write access. If you don't someone on the team will merge for you.

📌 The files in the repo make use of Insiders features. If you don't have Insiders, you can still build, but some features won't render in your build. However, you can see them on the preview site when you open a PR.

Resources

• Developer Center Wiki
• Formatting Cheatsheet
• Style Guide
• Known issues and hacks I don't feel bad about
• Contribution Guide
• Material Docs
• Markdown Link Check
• Vale Docs