Commit f19ba5b
committed
docs: fix inaccuracies in skill documentation
Correct pf-align fallback description (browser extraction, not markdown),
replace non-existent lint check (import order) with actual one (constructor
visibility), and add missing summary.md output mentions for pf-lint and
pf-status.1 parent b4a1c75 commit f19ba5b
1 file changed
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -28,7 +28,7 @@ Produces a markdown report and a JSON companion file: | |||
| 28 | 28 | ||
| 29 | 29 | ### /pf-align | |
| 30 | 30 | ||
| 31 | - Implements action items from a `/pf-compare` report. Reads the JSON companion file for structured data and cached HTML. Falls back to the markdown report if the JSON is not available. Translates reference HTML to the Java builder API and integrates it into the existing component. | ||
| 31 | + Implements action items from a `/pf-compare` report. Reads the JSON companion file for structured data and cached HTML. Falls back to browser extraction only when a specific variation's HTML is missing from the JSON. Translates reference HTML to the Java builder API and integrates it into the existing component. | ||
| 32 | 32 | ||
| 33 | 33 | ```bash | |
| 34 | 34 | /pf-align button | |
@@ -64,12 +64,12 @@ Verifies that a PFJ component follows the project's conventions for documentatio | |||
| 64 | 64 | /pf-lint card | |
| 65 | 65 | ``` | |
| 66 | 66 | ||
| 67 | - Writes per-component JSON reports to `docs/pf-lint/<component>.json`. Checks include: | ||
| 67 | + Writes per-component JSON reports to `docs/pf-lint/<component>.json` and an aggregate `docs/pf-lint/summary.md`. Checks include: | ||
| 68 | 68 | - Section markers and order (`factory`, `instance`, `add`, `builder`, `aria`, `events`, `api`, `internal`) | |
| 69 | 69 | - Javadoc completeness and format | |
| 70 | 70 | - Factory method naming | |
| 71 | 71 | - Modifier interface usage | |
| 72 | - - Import order and formatting | ||
| 72 | + - Constructor visibility and placement | ||
| 73 | 73 | ||
| 74 | 74 | ### /pf-status | |
| 75 | 75 | ||
@@ -80,7 +80,7 @@ Shows a unified status dashboard across lint, compare, align, and update dimensi | |||
| 80 | 80 | /pf-status button | |
| 81 | 81 | ``` | |
| 82 | 82 | ||
| 83 | - Reads JSON report files from previous skill runs — does not analyze source code directly. Writes a unified `docs/pf-status/summary.json`. | ||
| 83 | + Reads JSON report files from previous skill runs — does not analyze source code directly. Writes `docs/pf-status/summary.json` and `docs/pf-status/summary.md`. | ||
| 84 | 84 | ||
| 85 | 85 | ### /pf-update | |
| 86 | 86 | ||
@@ -139,7 +139,7 @@ The skills form a pipeline where each skill's output feeds into the next: | |||
| 139 | 139 | | `/pf-update` | Nothing (fetches from GitHub) | `docs/pf-update/<version>.md` + `.json` | | |
| 140 | 140 | | `/pf-compare` | Dev env running (for browser access) | `docs/pf-compare/<component>.md` + `.json` | | |
| 141 | 141 | | `/pf-align` | `docs/pf-compare/<component>.json` | `docs/pf-align/<component>.json` | | |
| 142 | - | `/pf-lint` | Nothing (reads source code directly) | `docs/pf-lint/<component>.json` + `summary.md` | | ||
| 142 | + | `/pf-lint` | Nothing (reads source code directly) | `docs/pf-lint/<component>.json` + `docs/pf-lint/summary.md` | | ||
| 143 | 143 | | `/pf-status` | JSON reports from other skills | `docs/pf-status/summary.json` + `summary.md` | | |
| 144 | 144 | ||
| 145 | 145 | ### Independent vs. Sequential | |
0 commit comments