Update build-plugin skill's readme template

[andrewmumblebee]

📋 Summary

The readme generated by the skill, could do with some order changes as noted in a lot of the PRs.

The old structure

1. What the plugin monitors — objects imported, what dashboards show
2. Prerequisites / getting credentials — step-by-step, include required scopes/permissions
3. Configuration fields — table explaining every `ui.json` field: what it is, where to find the value, whether required
4. What gets indexed — list object types and what they represent
5. Known limitations — rate limits, permission requirements, API quirks

This led to sections like

# Plugin name
## What the plugin monitors
## Prerequisites / getting credentials
## Configuration fields
## What gets indexed
## Known limitations

This could mean there was a lot of text before it gave guidance on actually setting up the plugin, unlike our docs site where it normally shows a short paragraph and goes straight into setup.

i.e. https://docs.squaredup.com/data-sources/jira-plugin

The new structure

<Overview: 1–3 sentences — what the plugin monitors, via which vendor API(s),
linking the product and the API docs.>

> ⚠️ <Optional: scope warning — editions/tiers/APIs the plugin does NOT
> cover. Omit the blockquote entirely if there's nothing to warn about.>

## Setup

<Numbered walkthrough from signing in to the vendor to pasting the credential
into the named config field. State required roles/scopes/permissions at the
step where the user grants them. Link every vendor page a step mentions.>

## Configuration fields

| Field | What it is | Where to find it | Required |
| ----- | ---------- | ---------------- | -------- |

<One row per ui.json field, bold field name matching its label exactly. After
the table: one sentence on what happens on save (the configValidation call)
and what a failure means.>

## What this plugin monitors

<Bullets grouping the data the way a user thinks about it, not the way the
API organizes it. Close with one line naming the out-of-the-box dashboards.>

## Data streams

<One bullet per stream: **displayName** — what it returns and its scope
(per-object or account-wide).>

## What gets indexed

| Object type | API source | Represents |
| ----------- | ---------- | ---------- |

<One row per objectType. Follow with a **Relationships:** line if objects
link to each other.>

## Known limitations

<Bullets: granularity/timeframe caps, rate limits, import count caps, data
freshness, permission constraints, and a read-only note if the plugin never
writes to the vendor.>

---

🔍 Scope of change

• Documentation only
• Repository metadata or configuration
• CI / automation
• Other (please describe):

---

📚 Checklist

• I agree to the Code of Conduct

[github-actions]

🧩 Plugin PR Summary

ℹ️ No plugins were modified in this PR.

[coderabbitai]

📝 Walkthrough

Walkthrough

The build-plugin skill is updated to version 0.0.12 and now defines a two-phase README process. A new reference template specifies structure, writing rules, an example, and a Phase 9 completion checklist before deployment.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title matches the main change: updating the build-plugin skill's README template.
Description check	✅ Passed	The description clearly covers the documentation-only change with summary, scope, and checklist sections.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

---

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.claude/skills/build-plugin/references/readme.md:
- Around line 143-144: Extend the README completion checklist entry for Known
limitations to explicitly require user-facing documentation of authentication
quirks, permission constraints, data freshness, and read-only behavior,
alongside the existing timeframe, payload, import-count, and rate-limit
constraints.

In @.claude/skills/build-plugin/SKILL.md:
- Around line 317-321: Update the Phase 9 workflow to require the README
completion checklist to pass in full and obtain explicit approval before
invoking deploy-plugin. Ensure deploy-plugin’s validation also passes before
deployment or re-indexing, and prevent any tenant-affecting change when either
the checklist, validation, or approval gate fails.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: 781f06ee-0b55-4c5b-b199-84695f933023

📥 Commits

Reviewing files that changed from the base of the PR and between 6d50ec4 and c6f0ccb.

📒 Files selected for processing (2)

• .claude/skills/build-plugin/SKILL.md
• .claude/skills/build-plugin/references/readme.md

[clarkd]

This looks great - fancy raising a subsequent PR that makes all the existing plugins follow this spec?