You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@magpie.apache.org by "justinmclean (via GitHub)" <gi...@apache.org> on 2026/07/29 00:14:44 UTC

[I] Add a docs/setup/README.md row for the setup skill itself [magpie]

justinmclean opened a new issue, #1005:
URL: https://github.com/apache/magpie/issues/1005

   ## 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)](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.


-- 
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: commits-unsubscribe@magpie.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Add a docs/setup/README.md row for the setup skill itself [magpie]

Posted by "Shriprasad-P (via GitHub)" <gi...@apache.org>.
Shriprasad-P commented on issue #1005:
URL: https://github.com/apache/magpie/issues/1005#issuecomment-5212169399

   Hi, I’d like to work on this issue.
   
   I’ll review `skills/setup/SKILL.md`, add the missing `setup` row to the table in `docs/setup/README.md` with an accurate description and link, then run `prek run --all-files` to validate the documentation and links.
   
   Could you please assign this issue to me?
   


-- 
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: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Add a docs/setup/README.md row for the setup skill itself [magpie]

Posted by "justinmclean (via GitHub)" <gi...@apache.org>.
justinmclean commented on issue #1005:
URL: https://github.com/apache/magpie/issues/1005#issuecomment-5212741687

   Hi @Shriprasad-P, looks like this issue has already been fixed by #1044, and teh issue was not closed. Sorry about 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: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Add a docs/setup/README.md row for the setup skill itself [magpie]

Posted by "justinmclean (via GitHub)" <gi...@apache.org>.
justinmclean closed issue #1005: Add a docs/setup/README.md row for the setup skill itself
URL: https://github.com/apache/magpie/issues/1005


-- 
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: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org