Skip to content

Add an anonymized technical case-study contribution template #228

Description

@rajudandigam

Contribution lane: documentation / community
Difficulty: good first issue
Ownership: community-owned
Priority: p2
Milestone: Public Proof & Adoption
Labels: documentation, good first issue, area:community, community-owned, status:ready, priority:p2
Baseline: agent-inspect@6.17.1 → 6.18.0 niche launch

Problem

There is no anonymized technical case-study template for partners to contribute public-safe proof narratives.

Why it matters

Public proof for 6.18 needs structured, anonymized write-ups — not raw traces.

Proposed scope

  • Add a markdown template for anonymized technical case studies.
  • Required fields: version, stack, scenario, what broke, what Evidence/TraceContract caught, outcome.
  • Explicit ban on secrets/customer identifiers/raw prompts if sensitive.

Out of scope

  • Fabricating case studies
  • Marketing pages as product scope
  • Uploading traces

Suggested files

  • docs/community/ template
  • Link from OSS roadmap / contributing

Acceptance criteria

  • Template exists
  • Privacy guidance explicit
  • Docs checks pass

Validation commands

pnpm docs:check
git diff --check

Privacy / network notes

Anonymized only. No customer data.

Contributor instructions

Good first docs. Comment first.

Maintainer-review boundary

Maintainers decide which case studies are featured publicly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:communityContributor experience and community docscommunity-ownedSuitable for community ownershipdocumentationDocumentation improvementsgood first issueSafe for new contributors; docs, fixtures, examplespriority:p2Medium prioritystatus:readyReady for contributors

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions