CtrlK
BlogDocsLog inGet started
Tessl Logo

using-docs-kit

Set up and author a documentation site with @lobehub/docs-kit (the `lobedocs` CLI, React Router + Vite static docs used by ui.lobehub.com). Covers consumer repo layout, docs.config.ts, package scripts, component doc pages (index.mdx frontmatter, `?demo` imports, <Demo>, <Api>), guide pages, home page, changelog, and the build-time validations that reject bad docs. Trigger on docs-kit, lobedocs, defineDocsConfig, docs.config.ts, migrate from dumi, write component docs, add a demo, <Demo>, <Api>, index.mdx, 文档站, 写文档, 组件文档, 迁移 dumi.

75

Quality

94%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

88%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A tightly written, highly actionable body: everything is kit-specific, executable, and organized around a validated build workflow. The only meaningful weaknesses are inlined version pins that will age, and reference links pointing to files that are absent from the bundle as shipped.

Suggestions

Ship reference/config.md and reference/validations.md in a references/ directory (and update the link paths from reference/ to references/) so the three in-body links and the 'Additional resources' section resolve instead of dead-ending.

Move the pinned dependency versions (@react-router/dev@8.2.0, react-router@8.2.0, vite@8.1.4, Node >= 22.22) into a short compatibility note or reference file, keeping the install snippet version-light so it doesn't age inside SKILL.md.

Consider adding one line to the workflow checklist telling the reader to verify the frontmatter description against the 'one or two plain sentences, no markdown' rule before building, since that is the most commonly botched field.

DimensionReasoningScore

Conciseness

The body is dense and kit-specific — compiler-enforced rules, the defineDocsConfig identity-function gotcha, 'restart lobedocs dev after editing docs.config.ts' — with no explanations of concepts Claude already knows. It falls just short of anchor 5 because time-sensitive version pins ('@react-router/dev@8.2.0', 'vite@8.1.4', 'Node >= 22.22') are inlined rather than confined to a compat/old-patterns note.

4 / 5

Actionability

Fully executable throughout: pnpm install commands, package.json scripts, a minimal docs.config.ts, a complete index.mdx template, frontmatter and <Demo> prop tables, JSDoc-to-API-table examples, and URL derivation rules. Copy-paste ready and covering the common cases (new page, demo, migration checklist).

5 / 5

Workflow Clarity

Section 6 gives a sequenced checklist with explicit validation checkpoints — 'lobedocs dev, open the page, check demos + API table render' and 'lobedocs build passes (it runs all audits)' — plus an error-recovery feedback loop ('the error lists the offending file and rule; see reference/validations.md for every rule and the fix'). This is not a destructive or batch operation, so no validation cap applies.

5 / 5

Progressive Disclosure

Good structure: config fields and validation rules are split into one-level-deep references, each clearly signaled with a content summary at point of use and again under 'Additional resources'. It falls short of anchor 5 because the referenced files (reference/config.md, reference/validations.md) do not exist in the skill's bundle — no references/ directory is present and the 'reference/' path prefix doesn't match the conventional layout — so the navigation dead-ends.

4 / 5

Total

18

/

20

Passed

Description

100%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

An exemplary description: concrete capability list, explicit trigger clause with natural and multilingual keywords, clear niche, and third-person imperative voice with no padding. Both 'what' and 'when' are answered explicitly and comprehensively.

DimensionReasoningScore

Specificity

Lists multiple concrete actions and artifacts — repo layout, docs.config.ts, package scripts, index.mdx frontmatter, `?demo` imports, <Demo>, <Api>, guide/home/changelog pages, build-time validations — comprehensively covering the skill's domain with no generic filler.

5 / 5

Completeness

Explicitly answers both questions: 'what' ("Set up and author a documentation site with @lobehub/docs-kit… Covers consumer repo layout… changelog, and the build-time validations") and 'when' ("Trigger on…") with concrete trigger phrases.

5 / 5

Trigger Term Quality

"Trigger on docs-kit, lobedocs, defineDocsConfig, docs.config.ts, migrate from dumi, write component docs, add a demo, <Demo>, <Api>, index.mdx, 文档站, 写文档, 组件文档, 迁移 dumi" covers natural user phrasings, identifiers, task-level synonyms, and localized variants — the kind of comprehensive coverage the top anchor asks for.

5 / 5

Distinctiveness Conflict Risk

Scoped to @lobehub/docs-kit and the lobedocs CLI with tool-specific triggers (defineDocsConfig, 迁移 dumi, index.mdx) that would not plausibly fire for other documentation-site skills, giving it a clear niche with minimal conflict risk.

5 / 5

Total

20

/

20

Passed

Validation

93%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

relative_links

Relative link issues: 5 missing

Warning

Total

15

/

16

Passed

Repository
lobehub/lobe-icons
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.