Skip to content

docs(education): add maintainer-education landing page and index#713

Open
justinmclean wants to merge 2 commits into
apache:mainfrom
justinmclean:education-landing-page
Open

docs(education): add maintainer-education landing page and index#713
justinmclean wants to merge 2 commits into
apache:mainfrom
justinmclean:education-landing-page

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

Creates docs/education/README.md — the landing page for the maintainer-
education stream (MISSION § Maintainer education, PRINCIPLE 18). The page
explains what the stream is, who it is for, and includes an index table
that starts with only the landing page itself and gains rows as the
remaining stream pages land (items 3–6 in the plan). Planned pages are
listed as plain text (no file links) so the link check stays clean until
each page arrives.

Links the page from docs/index.md (Where to go next table) and adds an
explicit docs/education/ pointer to MISSION.md so the RFC-AI-0004
back-reference to "MISSION.md for the maintainer-education stream"
resolves to the landing page via the established chain.

Generated-by: Claude (Opus 4.7)

Type of change

  • Skill change (.claude/skills/<name>/) — eval fixtures updated below
  • Tool / bridge contract (tools/<system>/*.md)
  • Python package (tools/*/ with pyproject.toml)
  • Groovy reference impl
  • Cross-cutting (RFC, AGENTS.md, sandbox, privacy-LLM)
  • Documentation (docs/, README.md, CONTRIBUTING.md)
  • Project template (projects/_template/)
  • CI / dev loop (prek, workflows, validators)
  • Other:

Test plan

  • prek run --all-files passes
  • For Python packages touched: uv run pytest / ruff check / mypy passes
  • For Groovy bridges touched: command-line invocation tested end-to-end
  • For skill changes: eval suite passes for the affected skill
    (PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)
  • For skill behaviour changes: a new or updated eval fixture is included in this PR
    (a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)
  • Other:

Creates docs/education/README.md — the landing page for the maintainer-
education stream (MISSION § Maintainer education, PRINCIPLE 18). The page
explains what the stream is, who it is for, and includes an index table
that starts with only the landing page itself and gains rows as the
remaining stream pages land (items 3–6 in the plan). Planned pages are
listed as plain text (no file links) so the link check stays clean until
each page arrives.

Links the page from docs/index.md (Where to go next table) and adds an
explicit docs/education/ pointer to MISSION.md so the RFC-AI-0004
back-reference to "MISSION.md for the maintainer-education stream"
resolves to the landing page via the established chain.

Generated-by: Claude (Opus 4.7)
Rewrite the maintainer-education landing page for a learner audience who may
be new to AI and AI terms, and for whom English may not be a first language.
Lead with a plain-language welcome, add a 'Words to know' glossary that
defines model, agent, prompt, skill, deterministic/probabilistic and eval
before they are used, and explain in short sentences why building with agents
is different. Simplify the coverage table and status labels (Ready / Coming
soon). The planned office-hours (workshops) page is dropped from the table.

Also drop office hours from MISSION.md (the 'first scheduled workshops'
deliverable and the 'Workshops and pairing sessions' education bullet), since
whether to run office hours is a PMC decision.

Generated-by: Claude (Opus 4.8)
@justinmclean justinmclean self-assigned this Jul 3, 2026
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