Skip to content

docs: add adoption guide, three real-world scenarios, and dogfooding badge#7

Merged
shenxianpeng merged 2 commits into
mainfrom
feature/adoption-guide-and-scenarios
May 30, 2026
Merged

docs: add adoption guide, three real-world scenarios, and dogfooding badge#7
shenxianpeng merged 2 commits into
mainfrom
feature/adoption-guide-and-scenarios

Conversation

@shenxianpeng
Copy link
Copy Markdown
Contributor

Summary

Adds the three most-requested ODS documentation improvements based on community feedback.

Changes

New: Adoption Guide (docs/adoption-guide.md)

A step-by-step enterprise rollout path that teams can copy directly:

  • Step 1: Add PR template (2 min)
  • Step 2: Add validate-action (5 min)
  • Step 3: Badge + report visibility (5 min)
  • Step 4: Progressive rollout — observe → warn → enforce
  • Step 5: AI disclosure
  • Step 6: Customize .ods.yaml
  • Includes team communication template and troubleshooting

New: Three Real-World Scenarios

  • Open-source project — Minimal setup, profile: oss, warnings-only, no AI disclosure
  • Enterprise internal service — Full L1 + AI disclosure, strict: true, audit trail, multi-repo adoption
  • AI-heavy coding team — 60-80% AI code, agent instructions, before/after PR comparison showing reviewer behavior change

Modified

  • README.md — Added ODS L1 badge and dogfooding note
  • docs/index.md — Added links to adoption guide and scenarios

Why

ODS's biggest adoption problem is the "why should I use this now?" question. These docs answer it with concrete, copy-paste paths for the three most common team profiles.

- New adoption-guide.md: step-by-step team rollout (observe → warn → enforce)
- New scenarios/: open-source, enterprise, and AI-coding team use cases
- Updated README with ODS badge and dogfooding note
- Updated docs/index.md with links to new pages
Use github.com/open-delivery-spec/spec for badge/project links,
open-delivery-spec.github.io/spec for docs pages.
@shenxianpeng shenxianpeng merged commit fa2941e into main May 30, 2026
2 checks passed
@shenxianpeng shenxianpeng deleted the feature/adoption-guide-and-scenarios branch May 30, 2026 18:12
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