ampproject / ampproject/amp.dev

Consolidate components Actions and Event documentations.

Open
#1,057 1 comment 0 reactions 1 assignee Claimed by @CrystalOnScript View on GitHub
Category: Documentation P2: Medium Type: Update
Dominant language
HTML
Stars
600
Forks
675
PR merge metrics
No merged PRs in 30d

Description

Currently there are two places actions and events for each components are documented.

1- Majority are in https://www.ampproject.org/docs/interaction_dynamic/amp-actions-and-events
2- Some components duplicated or sumemrized a version in their own `.md` file in addition to above.

Some suggestions:
1- https://www.ampproject.org/docs/interaction_dynamic/amp-actions-and-events to focus on how to use events and actions.
2- Separate documentation for common actions ( similar to common attributes)
3- All components to document their actions and events inside their own `.md` file.
4- Maybe https://www.ampproject.org/docs/interaction_dynamic/amp-actions-and-events can point to common and component actions as links?
5- Maybe the table on top of each component file can list attributes, events and action names same way it does for layouts for a quick overview?

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.