Skip to content

docs: update dev note with TL;DR tips and install instructions#461

Merged
johnnygreco merged 4 commits intomainfrom
docs/update-dev-note-and-install-instructions
Mar 25, 2026
Merged

docs: update dev note with TL;DR tips and install instructions#461
johnnygreco merged 4 commits intomainfrom
docs/update-dev-note-and-install-instructions

Conversation

@johnnygreco
Copy link
Copy Markdown
Contributor

Summary

  • Add a TL;DR tip block with four key lessons for building agent skills to the "Data Designer Got Skills" dev note
  • Remove Claude Code marketplace install option from blog and README, keeping only the skills.sh method
  • Update skill mode descriptions and clarify Claude Code testing scope
  • Add sentence about CLI delivering curated API context in the "Agents as First-Class Users" section

Add a tip block with four key lessons for building agent skills to the
"Data Designer Got Skills" dev note. Remove the Claude Code marketplace
install option from both the blog and README, keeping only the skills.sh
method. Update skill mode descriptions and clarify Claude Code testing scope.
@johnnygreco johnnygreco requested a review from a team as a code owner March 25, 2026 16:02
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 25, 2026

Greptile Summary

This is a documentation-only PR that streamlines the agent skill install story and enriches the "Data Designer Got Skills" dev note with actionable TL;DR tips.

Key changes:

  • Marketplace removal: Deletes .claude-plugin/marketplace.json, claude-plugin/.claude-plugin/plugin.json, and the claude-plugin/skills symlink, removing the Claude Code marketplace install path entirely. The canonical skill files under skills/data-designer/ are untouched and remain the source for the skills.sh workflow.
  • README URL fix: Corrects the devnote link from devnotes/posts/data-designer-got-skills/ to devnotes/data-designer-got-skills/, which matches the actual rendered URL under MkDocs Material's blog plugin with post_url_format: "{slug}".
  • TL;DR admonition: Adds a four-point tip block at the top of the dev note summarising the key lessons (consolidate API surface, build agent-friendly CLI commands, review session histories, benchmark against a baseline).
  • Prose clarity: Appends a sentence about CLI-delivered curated context to the "Agents as First-Class Users" section; marks interactive mode explicitly as the default; replaces the vague autopilot activation hint with concrete trigger phrases ("be opinionated", "surprise me").

Confidence Score: 5/5

  • Documentation-only changes with no code impact; safe to merge.
  • All five changed files are documentation or metadata files. The marketplace removal is intentional and coordinated with the content changes. The README URL fix corrects a real bug (wrong path under the MkDocs blog plugin). The prose additions and clarifications are accurate and consistent with the rest of the dev note. No regressions are possible from these changes.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/devnotes/posts/data-designer-got-skills.md Adds a TL;DR admonition tip block with four lessons for building agent skills, appends a sentence about CLI curated context to the "Agents as First-Class Users" section, fixes punctuation in the "Coding best practices" paragraph, clarifies interactive mode as the default, and expands the autopilot mode description with concrete trigger phrases. No issues found.
README.md Removes the Claude Code marketplace install block, consolidates to skills.sh only, and fixes the devnote URL from devnotes/posts/data-designer-got-skills/ to devnotes/data-designer-got-skills/ — the correct path per the MkDocs blog plugin's post_url_format: "{slug}" setting. Also adds context about Claude Code being the primary tested agent.
.claude-plugin/marketplace.json Deleted entirely — this file defined the Claude Code marketplace entry that pointed to ./claude-plugin. Removal is intentional as the marketplace install path is being dropped in favour of skills.sh.
claude-plugin/.claude-plugin/plugin.json Deleted — this was the plugin metadata used exclusively by the marketplace install path. The canonical plugin.json at skills/data-designer/.claude-plugin/plugin.json remains and is the correct location for the skills.sh workflow.
claude-plugin/skills Deleted symlink (../skills) — this provided the skills/ tree to the marketplace plugin bundle. No longer needed now that the marketplace path is removed; the actual skill files under skills/data-designer/ remain intact.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([User wants to install the skill]) --> B{Install method}
    B -->|skills.sh — only supported path| C["npx skills add NVIDIA-NeMo/DataDesigner\n(select Claude Code as agent)"]
    B -->|~~Claude Code marketplace~~ removed| X[❌ Removed in this PR]
    C --> D[Skill available in Claude Code]
    D --> E{Skill mode}
    E -->|Default| F["Interactive mode\n— agent asks clarifying questions,\n  user reviews samples & iterates"]
    E -->|'be opinionated' / 'surprise me'| G["Autopilot mode\n— agent makes all design decisions,\n  validates & generates without waiting"]
    F --> H["Output: standalone Python script\ncalling Data Designer's public API"]
    G --> H
Loading

Reviews (1): Last reviewed commit: "docs: remove claude-plugin marketplace d..." | Re-trigger Greptile

@johnnygreco johnnygreco merged commit e4bc401 into main Mar 25, 2026
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants