From 9fd58626f2dbd13eb5624dcea7cddd7cf7771a48 Mon Sep 17 00:00:00 2001 From: juliet Date: Wed, 3 Jun 2026 18:49:55 -0400 Subject: [PATCH] docs: add intention statement to README (#680) * docs: add intention statement to README and docs Adds a "Who Coop is for" section to the top-level README and the docs landing page, replacing the single-line audience statement that previously focused on "trust and safety teams" with a broader framing that explicitly includes solo developers and community teams without dedicated T&S staff. The three principles (platform-owns-its-policy, child-safety-is- prioritized, auditable-codebase) are drawn directly from the issue discussion and surface the project's ethos for new readers. Closes #287 Co-Authored-By: Claude Opus 4.7 (1M context) * docs: keep "designed for T&S teams" line alongside intention section Per review on #680, the existing one-line audience statement is load-bearing messaging on its own and shouldn't be replaced by the new "Who Coop is for" section. Restore it; the new section now lives as a standalone addition after the feature list and the original line. Co-Authored-By: Claude Opus 4.7 (1M context) * docs: Reduce duplication, making sure info is in the right place --------- Co-authored-by: Claude Opus 4.7 (1M context) Co-authored-by: Cassidy James Blaede --- README.md | 18 +++++++++++++++--- docs/README.md | 2 +- docs/user/README.md | 15 ++++++++++----- 3 files changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1729285..ff3cc30 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,17 @@ Coop is the open source review and moderation tool from [ROOST](https://roost.to - **Rules Engine**: Automated content evaluation against customizable policies - **API Integration**: Simple REST and GraphQL APIs for seamless platform integration -It's designed for trust and safety teams for online platforms of all sizes from small indie projects to large enterprise-scale deployments. +## Who Coop is for + +Coop is for anyone who needs to make online safety decisions: platforms of all sizes, solo developers, and community teams without dedicated trust and safety staff. + +Most moderation tooling is proprietary and priced for platforms that can already afford it. Coop is free and open source so your data stays within your infrastructure, and you can customize it for your community's needs. + +A few things that shape how we build it: + +- **The platform owns its policy.** Coop is the plumbing to implement and enforce your own rules. +- **Child safety is a prioritized workflow.** As the first free end-to-end online child safety system, it is one of the reasons Coop exists. +- **The codebase is auditable**, with no hidden logic and no vendor lock-in. ## Built in the open @@ -22,10 +32,12 @@ We want to hear from you! Whether you're testing it out, running into issues, or Your feedback directly shapes our [roadmap](https://roostorg.github.io/community/roadmap). -## Docker +## Quick start Run Coop with a single command using Docker Compose. See the [Docker guide](docs/development/docker.md) for setup instructions and published image details. ## Learn more -We maintain [documentation](docs/) directly in this repo covering functionality, development, integrations, and more. Versioned documentation is also [available online](https://roostorg.github.io/coop) for easier browsing. +See our comprehensive [documentation](https://roostorg.github.io/coop/latest) covering both functional and technical information including a user guide, development guide, API reference, and integration details. + +The docs are also available [directly in this repo](docs/) for your convenience. diff --git a/docs/README.md b/docs/README.md index 8a86028..f4b1393 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Welcome -Welcome to the Coop documentation! For the Coop source code and basic information, [check out Coop on GitHub](https://github.com/roostorg/coop). +Welcome to the Coop documentation! Visit [Coop on GitHub](https://github.com/roostorg/coop#readme) for source code and project information. These docs are split into a few guides, depending on who you are and what you're looking for: diff --git a/docs/user/README.md b/docs/user/README.md index 32c7af2..cc117c6 100644 --- a/docs/user/README.md +++ b/docs/user/README.md @@ -7,6 +7,7 @@ Coop enables you to protect your users from harm with remarkable ease. Coop is a trust and safety platform built around two functional areas that can be used independently or together: - **Automated Enforcement**: rules that evaluate every submitted item and automatically take action or route it to a review queue + - **Review Console**: a human review queue where moderators examine flagged content and make enforcement decisions This simplified diagram can help you better understand how data flows between a platform and Coop: @@ -17,12 +18,16 @@ This simplified diagram can help you better understand how data flows between a We recommend beginning by familiarizing yourself with Coop's [basic concepts](concepts.md). Once you're up to speed: -1. Ensure you have an account and API key for your Coop instance (find or generate one under **Settings** → **API Keys**) +1. Ensure you have an account and API key for your Coop instance + +2. Define your [Item Types](administration.md#item-types); the kinds of content and actors on your platform + +3. Input your detailed platform [Policies](administration.html#policies) -2. Define your [Item Types](administration.md#item-types); the kinds of content or users on your platform (posts, comments, profiles, etc.) +4. Define your [Actions](administration.md#actions) and expose [callback endpoints](../api/actions.md) so Coop can trigger enforcement on your platform -3. Define your [Actions](administration.md#actions) and expose callback endpoints so Coop can trigger enforcement on your platform; see [Handling Actions](../api/actions.md) for the webhook format +Once Coop is configured, your platform can: -4. Begin submitting items to Coop via the [Items API](../api/items.md) so they run through your proactive rules +1. Begin submitting items to Coop via the [Items API](../api/items.md) so they run through your proactive rules -5. Submit user reports via the [Report API](../api/report.md) to route them into review queues for your moderators +2. Submit user reports via the [Report API](../api/report.md) to route them into review queues for your moderators -- 2.51.2