Skip to content

Add a docs/setup/README.md row for the setup skill itself #1005

Description

@justinmclean

Summary

The setup family's documentation table lists every setup skill except setup — the bootstrap
skill the whole family depends on. Add a row for it.

Background

PR #798 filled three gaps in the table (setup-status, setup-override-upstream,
setup-upstream-fix) and bumped the skill count in the top-level README.md from 8 to 9. That
count is right: there are exactly nine skills/setup* directories.

But after that PR, skills/setup/SKILL.md is the only one of the nine with no row of its own.
Two of its sub-commands are listed — setup upgrade links skills/setup/upgrade.md and
setup verify links skills/setup/verify.md — but the skill's entry point is not, even though
skills/setup/SKILL.md exists alongside adopt.md, unadopt.md, overrides.md,
agents.md, worktree-init.md and skill-sources.md.

The top-level README calls this skill out by name — "The prerequisite — at minimum the setup
skill itself runs out of this family" — so a reader who follows that pointer into
docs/setup/README.md finds the family's other eight skills and not the one they were sent to
read about.

Where to look

  • docs/setup/README.md — the skill table; the existing rows show the format
    ([name](../../skills/name/SKILL.md) | one-sentence description).
  • skills/setup/SKILL.md — read this to describe what the skill does; do not infer it from the
    name.
  • README.md (repo root) — the families table, for the "9 skills" count this row makes true.

Acceptance criteria

  • docs/setup/README.md has a row linking ../../skills/setup/SKILL.md.
  • The description reflects what skills/setup/SKILL.md actually does.
  • The row is placed so the table still reads in a sensible order.
  • prek run --all-files passes, including the lychee link check.

Estimated effort

~30 minutes for someone new to the codebase.

Getting started

[How to contribute](https://github.com/apache/airflow-steward/blob/main/CONTRIBUTING.md#your-first-contribution)

This issue was drafted with the help of an AI-assisted tool and reviewed by a Magpie maintainer before posting. If anything here is unclear or looks wrong, say so on the issue: a real person is reading.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions