Skip to content

Commit 47429e2

Browse files
committed
docs: refresh contributor handbook
1 parent ba94e89 commit 47429e2

54 files changed

Lines changed: 722 additions & 38 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

lib/agent_jido/ecosystem/package.ex

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,9 @@ defmodule AgentJido.Ecosystem.Package do
114114
github_url: Zoi.string(description: "GitHub repository URL") |> Zoi.optional(),
115115
github_org: Zoi.string(description: "GitHub organization") |> Zoi.default("agentjido"),
116116
github_repo: Zoi.string(description: "GitHub repository name") |> Zoi.optional(),
117+
tech_lead:
118+
Zoi.string(description: "Canonical GitHub-handle-first owner or tech lead for the package")
119+
|> Zoi.optional(),
117120
elixir: Zoi.string(description: "Required Elixir version") |> Zoi.optional(),
118121
ecosystem_deps:
119122
Zoi.any(description: "List of ecosystem package id strings this depends on")

priv/content_plan/docs/contributors/_hub.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,24 @@
1010
destination_route: "/docs/contributors",
1111
ecosystem_packages: ["jido", "agent_jido"],
1212
learning_outcomes: ["Find the canonical ecosystem-level contribution standards",
13-
"Identify which contributor checklist or policy page applies to a package change"],
13+
"Identify which contributor page answers package ownership, support, quality, roadmap, or governance questions"],
1414
order: 1,
1515
prerequisites: [],
16-
purpose: "Section root organizing contributor-facing policy, package standards, and shared ecosystem workflows",
17-
related: ["docs/contributors/package-quality-standards", "docs/guides/_hub", "docs/reference/_hub"],
16+
purpose: "Section root organizing contributor-facing policy, package ownership, roadmap, and shared ecosystem workflows",
17+
related: ["docs/contributors/ecosystem-atlas", "docs/contributors/package-support-levels",
18+
"docs/contributors/package-quality-standards", "docs/contributors/roadmap",
19+
"docs/contributors/contributing", "docs/contributors/governance-and-team"],
1820
prompt_overrides: %{
19-
document_intent: "Create the contributors section hub that routes maintainers and outside contributors to canonical ecosystem contribution guidance.",
20-
required_sections: ["Overview", "Start Here", "What Belongs Here"],
21-
must_include: ["One-line description of the package quality standards page",
22-
"Clear statement that this section is the canonical contributor policy surface for the Jido ecosystem"],
23-
must_avoid: ["Duplicating the full checklist from child pages", "Long prose"],
24-
required_links: ["/docs/contributors/package-quality-standards", "/docs/guides", "/docs/reference"],
21+
document_intent: "Create the contributors section hub that routes maintainers and outside contributors to the canonical ecosystem handbook pages.",
22+
required_sections: ["Section Contents", "Common Entry Points"],
23+
must_include: ["Clear distinction between `/community` and `/docs/contributors`",
24+
"One-line description of each contributor page"],
25+
must_avoid: ["Duplicating the full content of child pages", "Long prose"],
26+
required_links: ["/docs/contributors/ecosystem-atlas", "/docs/contributors/package-support-levels",
27+
"/docs/contributors/package-quality-standards", "/docs/contributors/roadmap",
28+
"/docs/contributors/contributing", "/docs/contributors/governance-and-team", "/community"],
2529
min_words: 150,
26-
max_words: 400,
30+
max_words: 450,
2731
minimum_code_blocks: 0,
2832
diagram_policy: "none",
2933
section_density: "minimal",
@@ -33,10 +37,10 @@
3337
---
3438
## Content Brief
3539

36-
Section root for Contributors. Organizes canonical contributor policy and ecosystem package standards.
40+
Section root for Contributors. Organizes canonical contributor policy, ownership, roadmap, and ecosystem package standards.
3741

3842
### Validation Criteria
3943

40-
- Makes it obvious this is the contributor-facing standards area
41-
- Links directly to package quality standards
42-
- Keeps copy compact and easy to reference from PRs
44+
- Makes it obvious this is the contributor-facing handbook
45+
- Distinguishes `/community` from `/docs/contributors`
46+
- Links directly to all six contributor child pages
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
%{
2+
priority: :high,
3+
status: :outline,
4+
title: "Contributing Guide",
5+
repos: ["agent_jido"],
6+
tags: [:docs, :contributors, :contributing],
7+
audience: :beginner,
8+
content_type: :guide,
9+
destination_collection: :pages,
10+
destination_route: "/docs/contributors/contributing",
11+
ecosystem_packages: ["jido", "agent_jido"],
12+
learning_outcomes: ["Find the right contribution lane",
13+
"Understand how to start small and how stewardship works"],
14+
order: 5,
15+
prerequisites: [],
16+
purpose: "Contributor-facing guide for entering Jido contribution work across code, docs, testing, and stewardship",
17+
related: ["docs/contributors/package-quality-standards", "docs/contributors/governance-and-team",
18+
"docs/community/_hub"],
19+
prompt_overrides: %{
20+
document_intent: "Write the contributing page as a lightweight guide to participation and flow.",
21+
required_sections: ["Contribution Lanes", "Lightweight Contribution Flow", "How to Start Small"],
22+
must_include: ["Code, docs, examples, testing, and community contribution lanes",
23+
"Explanation that package stewardship is a contribution path"],
24+
must_avoid: ["Heavy process language", "Community CTA duplication that belongs on `/community`"],
25+
required_links: ["/community", "/docs/contributors/package-quality-standards",
26+
"/docs/contributors/governance-and-team"],
27+
min_words: 350,
28+
max_words: 900,
29+
minimum_code_blocks: 0,
30+
diagram_policy: "none",
31+
section_density: "minimal",
32+
max_paragraph_sentences: 2
33+
}
34+
}
35+
---
36+
## Content Brief
37+
38+
Contributor-facing guide for how people join and work in the ecosystem.
39+
40+
### Validation Criteria
41+
42+
- Makes it clear contributors can start small
43+
- Covers package stewardship as a lightweight path
44+
- Links to `/community` for social entry rather than duplicating it
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
%{
2+
priority: :high,
3+
status: :outline,
4+
title: "Ecosystem Atlas",
5+
repos: ["agent_jido"],
6+
tags: [:docs, :contributors, :ecosystem, :ownership],
7+
audience: :intermediate,
8+
content_type: :reference,
9+
destination_collection: :pages,
10+
destination_route: "/docs/contributors/ecosystem-atlas",
11+
ecosystem_packages: ["jido", "jido_action", "jido_signal", "jido_ai", "req_llm"],
12+
learning_outcomes: ["Find the current public package roster and ownership map",
13+
"Distinguish support label from release state and package purpose"],
14+
order: 2,
15+
prerequisites: [],
16+
purpose: "Contributor-facing public package roster organized by the current brainstorm ecosystem groups with support level, owner, release state, and purpose",
17+
related: ["docs/contributors/package-support-levels", "docs/contributors/roadmap",
18+
"ecosystem/overview"],
19+
prompt_overrides: %{
20+
document_intent: "Write the Ecosystem Atlas page as a concise contributor-facing package roster.",
21+
required_sections: ["Integration / Framework", "Core / Runtime", "AI / LLM",
22+
"Messaging", "Harness / CLI", "Planning / Control", "Runtime / Interfaces",
23+
"Runtime / Distributed", "Memory / Storage", "Observability / Telemetry",
24+
"Developer Tools / UI", "Automation / Bots", "Evaluation / Testing"],
25+
must_include: ["One compact markdown table per category",
26+
"Columns for package, support, owner, release, and purpose",
27+
"Short note that deeper package pages live under `/ecosystem`",
28+
"Group names aligned to the current `jido_brainstorm` ecosystem inventory"],
29+
must_avoid: ["Private packages", "Long package-by-package narrative"],
30+
required_links: ["/ecosystem", "/docs/contributors/package-support-levels",
31+
"/docs/contributors/roadmap"],
32+
min_words: 500,
33+
max_words: 1200,
34+
minimum_code_blocks: 0,
35+
diagram_policy: "none",
36+
section_density: "minimal",
37+
max_paragraph_sentences: 2
38+
}
39+
}
40+
---
41+
## Content Brief
42+
43+
Contributor-facing package roster for the public Jido ecosystem.
44+
45+
### Validation Criteria
46+
47+
- Includes only public packages
48+
- Groups packages by the current brainstorm ecosystem sections
49+
- Shows owner handles and release state distinctly from support level
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
%{
2+
priority: :medium,
3+
status: :outline,
4+
title: "Governance and Team Structure",
5+
repos: ["agent_jido"],
6+
tags: [:docs, :contributors, :governance, :team],
7+
audience: :intermediate,
8+
content_type: :guide,
9+
destination_collection: :pages,
10+
destination_route: "/docs/contributors/governance-and-team",
11+
ecosystem_packages: ["jido", "agent_jido"],
12+
learning_outcomes: ["Understand how Jido makes decisions",
13+
"Understand how repository ownership and cross-cutting teams fit together"],
14+
order: 6,
15+
prerequisites: [],
16+
purpose: "Contributor-facing governance page describing the BDFL model, repository ownership, and cross-cutting teams",
17+
related: ["docs/contributors/ecosystem-atlas", "docs/contributors/contributing"],
18+
prompt_overrides: %{
19+
document_intent: "Write the governance page as a direct explanation of responsibility and decision making.",
20+
required_sections: ["Governance Model", "Repository Ownership", "Cross-Cutting Teams", "Inactive Ownership"],
21+
must_include: ["Mike Hostetler as BDFL",
22+
"Community team present without a named lead unless updated elsewhere",
23+
"Documentation lead as TBD unless updated elsewhere"],
24+
must_avoid: ["Corporate or bureaucratic language", "Hidden ownership assumptions"],
25+
required_links: ["/docs/contributors/ecosystem-atlas", "/docs/contributors/contributing"],
26+
min_words: 350,
27+
max_words: 900,
28+
minimum_code_blocks: 0,
29+
diagram_policy: "none",
30+
section_density: "minimal",
31+
max_paragraph_sentences: 2
32+
}
33+
}
34+
---
35+
## Content Brief
36+
37+
Contributor-facing governance and responsibility guide.
38+
39+
### Validation Criteria
40+
41+
- Explains the lightweight BDFL model clearly
42+
- Makes repository ownership explicit and links to the atlas
43+
- Covers inactive ownership handling and cross-cutting teams

priv/content_plan/docs/contributors/package-quality-standards.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,18 @@
1515
order: 10,
1616
prerequisites: ["docs/contributors/_hub"],
1717
purpose: "Canonical contributor-facing checklist for Jido ecosystem package quality, CI, documentation coverage, and GitOps-style release readiness",
18-
related: ["docs/reference/configuration", "docs/guides/testing-agents-and-actions", "ecosystem/overview"],
18+
related: ["docs/contributors/ecosystem-atlas", "docs/contributors/package-support-levels",
19+
"docs/reference/configuration", "docs/guides/testing-agents-and-actions", "ecosystem/overview"],
1920
source_files: ["GENERIC_PACKAGE_QA.md"],
2021
prompt_overrides: %{
2122
document_intent: "Create the canonical package standards page contributors and agents should use to verify Jido ecosystem package quality requirements.",
22-
required_sections: ["Scope", "Package Structure", "Shared Building Blocks", "Quality Gates", "Release Workflow", "Contributor Checklists"],
23-
must_include: ["Explicit `mix quality` policy",
24-
"GitOps-style release workflow expectations",
23+
required_sections: ["Fast Path Checklist", "How to use this page", "Package Structure", "Shared Building Blocks", "Quality Gates", "Release Workflow", "Contributor Checklists"],
24+
must_include: ["Short explanation that quality standards are distinct from support levels",
25+
"Explicit `mix quality` policy", "GitOps-style release workflow expectations",
2526
"Contributor checklists for new packages, first release, and ongoing maintenance"],
2627
must_avoid: ["Package-specific implementation details that belong in per-repo docs"],
27-
required_links: ["/docs/contributors", "/docs/reference", "/ecosystem"],
28+
required_links: ["/docs/contributors", "/docs/contributors/ecosystem-atlas",
29+
"/docs/contributors/package-support-levels", "/docs/reference", "/ecosystem"],
2830
min_words: 900,
2931
max_words: 2200,
3032
minimum_code_blocks: 3,
@@ -40,6 +42,8 @@ Canonical checklist and standards page for public Jido ecosystem packages. This
4042

4143
### Validation Criteria
4244

45+
- Includes a fast review path near the top
46+
- Distinguishes quality standards from support level and package roster pages
4347
- Covers repo structure, quality gates, docs coverage, CI, and release workflow
4448
- States the canonical package policies clearly enough to link from PRs
4549
- Includes actionable checklists, not just prose
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
%{
2+
priority: :high,
3+
status: :outline,
4+
title: "Package Support Levels",
5+
repos: ["agent_jido"],
6+
tags: [:docs, :contributors, :support, :taxonomy],
7+
audience: :intermediate,
8+
content_type: :reference,
9+
destination_collection: :pages,
10+
destination_route: "/docs/contributors/package-support-levels",
11+
ecosystem_packages: ["jido", "jido_ai", "req_llm"],
12+
learning_outcomes: ["Understand the meaning of Stable, Beta, and Experimental",
13+
"Avoid confusing support labels with roadmap priority or release state"],
14+
order: 3,
15+
prerequisites: [],
16+
purpose: "Canonical support taxonomy for public Jido packages",
17+
related: ["docs/contributors/ecosystem-atlas", "docs/contributors/roadmap"],
18+
prompt_overrides: %{
19+
document_intent: "Write the package support levels page as a tight policy reference.",
20+
required_sections: ["Support Levels", "What This Label Is And Is Not", "When To Use Each Label"],
21+
must_include: ["Clarification that support level is not packaging status",
22+
"Clarification that support level is not roadmap priority"],
23+
must_avoid: ["Package-by-package roster detail"],
24+
required_links: ["/docs/contributors/ecosystem-atlas", "/docs/contributors/roadmap"],
25+
min_words: 300,
26+
max_words: 800,
27+
minimum_code_blocks: 0,
28+
diagram_policy: "none",
29+
section_density: "minimal",
30+
max_paragraph_sentences: 2
31+
}
32+
}
33+
---
34+
## Content Brief
35+
36+
Canonical support taxonomy for public Jido packages.
37+
38+
### Validation Criteria
39+
40+
- Keeps definitions separate from package assignments
41+
- Explains how contributors should choose a support label
42+
- Distinguishes support commitment from release state and roadmap sequencing
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
%{
2+
priority: :medium,
3+
status: :outline,
4+
title: "Contributors Roadmap",
5+
repos: ["agent_jido"],
6+
tags: [:docs, :contributors, :roadmap],
7+
audience: :intermediate,
8+
content_type: :guide,
9+
destination_collection: :pages,
10+
destination_route: "/docs/contributors/roadmap",
11+
ecosystem_packages: ["jido", "jido_chat", "jido_harness"],
12+
learning_outcomes: ["Understand the current milestone and next milestone",
13+
"See how roadmap timing differs from support commitment"],
14+
order: 4,
15+
prerequisites: [],
16+
purpose: "Contributor-facing roadmap page translating milestone and epic planning into a compact public guide",
17+
related: ["docs/contributors/package-support-levels", "docs/contributors/ecosystem-atlas"],
18+
prompt_overrides: %{
19+
document_intent: "Write a concise contributor-facing roadmap page from the current milestone planning.",
20+
required_sections: ["Major Milestones", "Current Milestone", "Next Milestone", "Active Epics"],
21+
must_include: ["Current milestone, next milestone, and active epics",
22+
"Clarification that roadmap timing differs from support level"],
23+
must_avoid: ["Backlog-level detail", "Long historical narrative"],
24+
required_links: ["/docs/contributors/package-support-levels", "/docs/contributors/ecosystem-atlas"],
25+
min_words: 350,
26+
max_words: 900,
27+
minimum_code_blocks: 0,
28+
diagram_policy: "none",
29+
section_density: "minimal",
30+
max_paragraph_sentences: 2
31+
}
32+
}
33+
---
34+
## Content Brief
35+
36+
Contributor-facing roadmap for the public Jido ecosystem.
37+
38+
### Validation Criteria
39+
40+
- Preserves milestone names and leads from source planning
41+
- Keeps the page directional rather than backlog-like
42+
- Explains how roadmap relates to the atlas and support levels

priv/ecosystem/ash_jido.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
github_url: "https://github.com/agentjido/ash_jido",
1313
github_org: "agentjido",
1414
github_repo: "ash_jido",
15+
tech_lead: "@mikehostetler",
1516
maturity: :stable,
1617
support_level: :stable,
1718
hex_status: "unreleased",

priv/ecosystem/jido.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
github_url: "https://github.com/agentjido/jido",
1616
github_org: "agentjido",
1717
github_repo: "jido",
18+
tech_lead: "@mikehostetler",
1819
elixir: "~> 1.17",
1920
maturity: :stable,
2021
support_level: :stable,

0 commit comments

Comments
 (0)