feat(skills): ship a Claude Code skill for integrating the framework - #19
Merged
Conversation
Adds skills/inkform-framework/SKILL.md — an agent skill that adds MDX docs, a blog, or a changelog to a Next.js site and opens the PR, plus the marketplace manifests that make it installable in one command and a docs page so it's discoverable at framework.inkform.dev. The skill encodes the failure modes the guides describe but don't emphasise: - transpilePackages: ['@inkform/framework'] is mandatory, since the package ships TS/JSX source. Omitting it causes most "unexpected token" build errors. - Next >=16 and React 19 are a hard floor. On an older site the skill stops and says so rather than bumping a major version inside a content PR — that's a separate piece of work with its own risk. - Adding a blog to an existing site must not transplant the docs shell over that site's own layout and design system. They asked for /blog, not a theme. - Every docs page must be registered in docs.json; a file on disk that isn't listed won't route. - Merge into the existing next.config.ts rather than replacing it. Installable three ways so nobody has to adopt a plugin to benefit: the marketplace manifest, the self-contained SKILL.md copied into ~/.claude/skills/, or just linking the published guide in a prompt. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XicaJv3aZTSWCZsiQR1YgW
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
An agent skill that adds MDX docs, a blog, or a changelog to a Next.js site and opens the PR — so integrating the framework across several sites doesn't mean re-deriving it each time.
What's here
skills/inkform-framework/SKILL.md— the skill itself, self-contained markdown..claude-plugin/— marketplace + plugin manifests, so it installs in one command.skills/README.md— the three install routes.examples/inkform-docs/content/docs/guides/claude-code-skill.mdx— a docs page so it's discoverable on framework.inkform.dev, registered indocs.json.What the skill encodes
The published guides explain how the framework works. The skill adds what goes wrong:
transpilePackages: ['@inkform/framework']is mandatory — the package ships TS/JSX source, and omitting it causes most "unexpected token" build failures./blog, not a theme.next.config.ts, don't replace it.docs.json— a file on disk that isn't listed won't route.Install (any of three)
…or copy
SKILL.mdinto~/.claude/skills/, or linkframework.inkform.devin a prompt with no install at all.Test plan
examples/inkform-docsbuilds; 25 static pages generate, including/guides/claude-code-skilldocs.jsonedit is a 2-line insertion — formatting preserved, no reflowguides/blog-in-existing-site,getting-started/quickstart, andreference/framework-apiso it doesn't contradict themCompanion skill for newsletter signup and the platform API lives in inkform-dev/cms#26.
🤖 Generated with Claude Code
https://claude.ai/code/session_01XicaJv3aZTSWCZsiQR1YgW