Skip to content

docs: polish marketplace README with Why ODS, pass/fail examples, and dogfooding#10

Merged
shenxianpeng merged 2 commits into
mainfrom
feature/marketplace-polish-and-dogfooding
May 30, 2026
Merged

docs: polish marketplace README with Why ODS, pass/fail examples, and dogfooding#10
shenxianpeng merged 2 commits into
mainfrom
feature/marketplace-polish-and-dogfooding

Conversation

@shenxianpeng
Copy link
Copy Markdown
Contributor

Summary

Polishes the GitHub Marketplace README to serve as the primary adoption entry point for ODS.

Changes

Added

  • ODS L1 badge and dogfooding note — shows ODS validates its own PRs
  • "Why ODS?" section — before/after comparison table at the top of the README
  • "What You'll See" section — realistic passing and failing PR comment examples with the exact format users will see
  • SARIF added to the artifact directory listing

Modified

  • Header area redesigned as a landing page — tagline, value proposition, badge, dogfooding

Why

The validate-action README is the most common entry point for new ODS users (it's what they see on GitHub Marketplace). It needs to immediately answer: what is this, what will I see, and why should I install it.

… dogfooding badge

- Added ODS L1 badge and dogfooding note
- Added 'Why ODS?' section with before/after comparison table
- Added 'What You'll See' section with passing and failing PR comment examples
- Updated artifact listing to include SARIF output
Use github.com/open-delivery-spec/spec for the project badge link.
@shenxianpeng shenxianpeng merged commit 694a968 into main May 30, 2026
3 checks passed
@shenxianpeng shenxianpeng deleted the feature/marketplace-polish-and-dogfooding branch May 30, 2026 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant