Why
examples/github-action-sample covers a generic static site/ folder. Docs-as-code users (VitePress / Docusaurus) are the people who actually pin a CI lint. They currently have to invent the path: mapping.
Ask
Add one advisory-mode sample workflow for either VitePress or Docusaurus (not both unless they share the same output directory pattern):
- uses: cucuwang/aeoptimize@v0.6.2
with:
path: <build-output>
fail-on-low-score: 'false'State the default build output directory in a short README next to the sample. Keep the Action advisory by default. Do not add blocking min-score as the sample default.
Out of scope
A new framework plugin. Scoring-rule changes.
Pointers
examples/github-action-sample/action.yml- README CI contract section
Why
examples/github-action-samplecovers a generic staticsite/folder. Docs-as-code users (VitePress / Docusaurus) are the people who actually pin a CI lint. They currently have to invent thepath:mapping.Ask
Add one advisory-mode sample workflow for either VitePress or Docusaurus (not both unless they share the same output directory pattern):
State the default build output directory in a short README next to the sample. Keep the Action advisory by default. Do not add blocking
min-scoreas the sample default.Out of scope
A new framework plugin. Scoring-rule changes.
Pointers
examples/github-action-sample/action.yml