Refresh extending-pi skill guidance#43
Merged
Merged
Conversation
🔍 Tessl Skill Review
|
| Dimension | Score | Detail | Suggestion |
|---|---|---|---|
| conciseness | ██░ 2/3 | efficient and avoids explaining basic concepts, but some sections are verbose—particularly the patch policy and extension workflow sections repeat the 'read the docs' instruction multiple times. The table is well-structured but the surrounding prose could be tightened. | Add at least one minimal, executable scaffold example (e.g., a skeleton TypeScript extension or a minimal SKILL.md frontmatter) so the skill provides some copy-paste-ready starting point than purely routing to docs. |
| actionability | ██░ 2/3 | The skill provides concrete CLI commands for validation (e.g., pi --no-skills --skill /path/to/skill, pi -e ./path/to/extension.ts) and clear file paths, but deliberately avoids executable code examples, API signatures, or copy-paste-ready scaffolding. It routes to docs than providing directly actionable content, which is a design choice but reduces immediate actionability. |
Consolidate repeated 'read the docs first' instructions across the behavior-change triage, extension workflow, and patch policy sections to reduce redundancy and improve token efficiency. |
| workflow clarity | ███ 3/3 | The behavior-change triage is a well-sequenced 5-step process with a clear escalation path and explicit gate before patching. The TypeScript extension workflow is a 6-step audit with validation checkpoints. The quick-start steps provide a clear overall sequence with validation for each artifact type. The patch policy includes a stop-and-verify checkpoint before proceeding. | |
| progressive disclosure | ███ 3/3 | structured as a routing/overview document that explicitly points to specific docs, examples, and type files for each extension point. References are one level deep and clearly signaled in the table's 'Detailed source of truth' column. The skill explicitly states 'not an API reference' and routes to the right detailed sources. |
extending-pi/skill-creator/SKILL.md
Review Details
Review Details
| Dimension | Score | Detail | Suggestion |
|---|---|---|---|
| conciseness | ██░ 2/3 | efficient but includes some unnecessary explanation (e.g., explaining what README.md is for, the {baseDir} placeholder note, and some obvious guidance like 'Only add resource sub-directories that are needed'). Could be tightened in several places, though it avoids egregious padding. |
Trim explanatory sentences that state the obvious (e.g., 'If you plan to share the skill with humans, a README.md helps discovery and installation') to improve conciseness. |
| actionability | ███ 3/3 | Provides concrete, executable commands throughout (mkdir, touch, bash validation commands, pi CLI invocations), specific frontmatter examples with correct YAML syntax, and clear directory structures. The guidance is copy-paste ready at each step. | Consider condensing the 'Agent Skills format' section into a more compact reference table than a bullet list with full sentences. |
| workflow clarity | ███ 3/3 | The 9-step workflow is clearly sequenced from clarification through publishing, with an explicit validation step (step 8) that includes multiple verification methods (validator script, loading with --no-skills, explicit invocation, /reload after edits). The progression is logical and each step builds on the previous one. | |
| progressive disclosure | ███ 3/3 | Content is well-structured with a clear overview of the format, recommended structure, then a step-by-step workflow. References to external files (references/PUBLISHING.md) are one level deep and clearly signaled with when to consult them. The skill appropriately keeps the body as an overview and delegates detailed publishing info to a reference file. |
Optional: add a Tessl API token as TESSL_API_TOKEN in your repo secrets. The action will suggest an optimized version automatically in future PRs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
extending-pi/skill-creator/scripts/validate_skill.py extending-piextending-pi/skill-creator/scripts/validate_skill.py extending-pi/skill-creatorpython3 -m json.toolon root and nested package manifestsgit diff --checknpm pack --dry-run --jsoninextending-piandextending-pi/skill-creator