ampproject / ampproject/amp-toolbox

Document new autoscript behavior more fully

Open
#589 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
459
Forks
242
PR merge metrics
No merged PRs in 30d

Description

Can you explain more fully in the readme.md what the automatic script inclusion mechanism is, why it's useful, and if there are cases where it might fail?

Also can you document it on [NPM](https://www.npmjs.com/package/@ampproject/toolbox-optimizer)?

/cc @garanj . If amp-toolbox becomes the preferred tool here, we should mention that and link to it on [the npm page for amphtml-autoscript](https://www.npmjs.com/package/amphtml-autoscript).

Contributor guide

Open the contributing guide

Research direction

Start with readme.md and review the automatic script inclusion mechanism described by the issue. Update the README and the relevant NPM pages to explain how it works, why it is useful, possible failure cases, and whether amp-toolbox should be linked as the preferred tool.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.