docs: README/CONTRIBUTING follow-ups (link fix, drop 'How skills work', remove template)#34
Merged
Merged
Conversation
Links inside backticks render as literal code on github.com instead of clickable links. Move the backticks inside the link text so skill names keep their monospace styling while remaining clickable. Affects all 11 skill catalog rows + the extensibility docs pointer.
Authors now copy any existing skill from skills/ that matches the shape they want (router, multi-step pipeline, docs/lookup) instead of starting from a template that was already drifting from current Labs conventions. - Delete skills/_template-skill-name/ - README: replace 'Copy the template' step with 'Start from an existing skill'; remove template entry from repo structure - CONTRIBUTING: replace 'SKILL.md template' section with 'Starting point' pointing at concrete examples (rbac, mlops, entity-resolution, dcr-v1-to-v2, snowflake-docs); drop two stale 'see the template' recommendations
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
1 participant
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
Three follow-ups to PR #33 (readme revamp). Three independent fixes that landed after #33 was already merged.
Fixes
fix(readme): unwrap link syntax from backticks so links render. The 11 skill catalog rows used`[skill-name](skills/skill-name)`— the backticks around the entire markdown link made it render as literal code on github.com instead of a clickable link. Moved backticks inside the link text →[`skill-name`](skills/skill-name). Skill names keep their monospace styling AND become clickable.docs(readme): drop "How skills work" section per review feedback. Removed the progressive-disclosure explanation and inline minimalSKILL.mdexample (41 lines). Authoring section already covers what contributors need.remove _template-skill-name; point authors at existing skills. Deleted the template directory (was already drifting from current Labs conventions). README authoring step 1 now reads "Start from an existing skill — pick any skill inskills/whose shape matches what you're building (e.g.rbacfor a router skill,entity-resolutionfor a multi-step pipeline)." CONTRIBUTING.md updated correspondingly: replaced the "SKILL.md template" section with a "Starting point" section pointing at concrete examples by skill shape, and dropped two stale "see the template" mentions in the recommendations.Test plan
skills/_template-skill-name/is gone from the file tree