ampproject / ampproject/amphtml
Improve documentation for BaseElement['props']
- Dominant language
- JavaScript
- Stars
- 14.9k
- Forks
- 4.1k
- PR merge metrics
- No merged PRs in 30d
Description
The [Building a Bento AMP Component](https://github.com/ampproject/amphtml/blob/master/contributing/building-a-bento-amp-extension.md) doc doesn't say much about `BaseElement['props']` and should at least enumerate what all the configuration options are: https://github.com/ampproject/amphtml/blob/6a860045e793ee398bd53b079db508e311bcfdd1/src/preact/base-element.js#L51-L70
Likewise for the [AMP/Preact Bridge doc](https://docs.google.com/document/d/1mOjmA56HNZGfTtLH51kFpZXSadpk0YYoEikxe6TJA_0/edit?pli=1#heading=h.7eeus2c8hd6y).
Contributor guide
Research direction
Start with src/preact/base-element.js around lines 51-70 to identify the BaseElement['props'] configuration options. Update contributing/building-a-bento-amp-extension.md and the AMP/Preact Bridge document to enumerate those options, then verify both documents describe the complete configuration consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100