ampproject / ampproject/amp.dev

Import AMP Shadow Doc API documentation into amp.dev

Open
#3,090 2 comments 3 reactions 1 assignee Claimed by @CrystalOnScript View on GitHub
Category: Content P2: Medium Type: New
Dominant language
HTML
Stars
600
Forks
675
PR merge metrics
No merged PRs in 30d

Description

## 📖 Missing or out-of-date documentation

**Describe the content that is missing or should be up dated**

The [AMP Shadow Doc API](https://github.com/ampproject/amphtml/blob/master/spec/amp-shadow-doc.md#shadow-doc-api) documentation deserves a home on amp.dev. There exists [partial documentation](https://amp.dev/documentation/guides-and-tutorials/integrate/amp-in-pwa/), but it is more of a "how to get started" than a resource for developers.

**Which part of the site would that content live at?**

The most suitable documentation category would be "Runtimes", but I'm not sure what else would live in this new category. I'm not passionate about its location, as long as it's easier to find than the GitHub spec document.

**What's the type of content?**

API documentation (moderately technical).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.