potiuk commented on code in PR #449:
URL: https://github.com/apache/airflow-steward/pull/449#discussion_r3356442074


##########
docs/index.md:
##########
@@ -0,0 +1,76 @@
+# What is Apache Magpie?
+
+Apache Magpie is an AI assistant for open-source project maintainers. It 
handles the repetitive parts of running a project — triaging issues, reviewing 
PRs, onboarding contributors, managing security reports, cutting releases — so 
maintainers can spend their time on design, relationships, and the work that 
actually requires a human.
+
+**The agent proposes. The human decides.** Magpie never merges, never pushes, 
never sends mail, never flips a label without a maintainer confirming first.
+
+---
+
+## How it works
+
+Magpie provides **skills** — step-by-step workflows an AI agent follows. You 
pick which skills your project uses. The agent reads your issues, PRs, or 
security reports, does the analysis, and drafts a response. You review it and 
hit "go" (or don't).
+
+Five **modes** describe what the agent can do, from low-risk to high:
+
+| Mode | What it does | Status |
+|---|---|---|
+| **Triage** | Classify issues/PRs, spot duplicates, propose labels | Stable |
+| **Mentoring** | Help contributors with conventions, point to examples | 
Experimental |
+| **Drafting** | Write a code fix or a PR for you to review | Stable 
(security) |
+| **Pairing** | Self-review your own code before submitting | Experimental |
+| **Auto-merge** | Merge trivial changes without human review | Off 
(deliberately) |
+
+Each project picks the modes that fit. You can run just Triage and nothing 
else.
+
+---
+
+## Who is this for?
+
+### Maintainers wanting to adopt Magpie in their project
+
+You have an open-source project with an issue tracker and/or PR queue, and you 
want agent assistance with the mechanical parts.
+
+→ Start with the [README](../README.md#adopting-the-framework) (adoption 
steps) and [install recipes](setup/install-recipes.md).
+
+### Security team members
+
+You handle CVE reports and want agent help with the 16-step lifecycle — 
import, triage, fix, allocate, publish.
+
+→ Start with [security workflow overview](security/README.md), then [new 
member onboarding](security/new-members-onboarding.md).
+
+### Contributors to the Magpie framework itself
+
+You want to improve the skills, add tools, or fix bugs in the framework.
+
+→ Start with [CONTRIBUTING.md](../CONTRIBUTING.md) and the [spec-driven 
development](spec-driven-development.md) loop.
+
+### People evaluating whether to adopt
+
+You want to understand the trust model, cost, and governance commitments 
before deciding.
+
+→ Read [MISSION.md](../MISSION.md) (the why), 
[PRINCIPLES.md](../PRINCIPLES.md) (the rules), and [mode 
economics](mode-economics.md) (what it costs in tokens).
+
+---

Review Comment:
   Smth like that :) 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to