skills.rest
massCodeIO
massCodeIOOFFICIAL
Explore all skills by this author →
WebsiteGitHub

documentation-workflow

Guides writing and updating massCode VitePress documentation pages, sidebar entries, and README mentions.

7.0k|264|Updated Mar 29, 2022
Search Tags:#Markdown#Technical Writing#Documentation#Versioning#ReadMe#vitePress#docs workflow
One-click install
npx skills add https://github.com/massCodeIO/massCode --skill documentation-workflow
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-workflow
Source: https://github.com/massCodeIO/massCode/tree/main/.agents/skills/documentation-workflow
Command: npx skills add https://github.com/massCodeIO/massCode --skill documentation-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeping massCode's VitePress documentation accurate and consistent is hard: features must be verified against code, version markers must reflect when a capability first appeared, and pages must be placed correctly in the sidebar and information architecture. This Skill encodes those editorial rules so documentation updates stay correct and consistent.

Core Features & Use Cases

  • Docs authoring rules: Enforces verification of feature behavior in code before documenting, task-oriented sections, and correct placement across docs/website/documentation, the VitePress sidebar config, and README.
  • Version availability management: Governs <AppVersion> markers so base capabilities keep their original version while enhancements get their own markers.
  • VitePress-specific guidance: Covers callout usage, image handling with withBase, and the {{ }} Vue-interpolation gotcha requiring v-pre in inline code.
  • Use Case: When adding a new massCode feature, use this Skill to write the docs page, register it in docs/website/.vitepress/config.mts, add assets to docs/website/public, and validate with pnpm -C docs/website build.

Quick Start

Use the documentation-workflow skill to document the new snippet tagging feature in the massCode docs website.

Frequently Asked Questions about documentation-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document a new feature in a VitePress documentation site?▼

Verify the feature's behavior in the source code first, then write a task-oriented page in the docs directory with frontmatter title and description. Add the page to the VitePress sidebar config only if it should appear in navigation, and validate with the site build.

How do I add a new page to the VitePress sidebar navigation?▼

Edit the sidebar configuration in docs/website/.vitepress/config.mts and add an entry for the new page. Only register pages that should appear in navigation; standalone or linked pages do not need sidebar entries.

Why do double curly braces disappear from my VitePress markdown page?▼

VitePress compiles markdown as Vue components, so {{ ... }} is treated as Vue interpolation and removed from output, even inside inline backtick code. Wrap literal braces in <code v-pre>{{variables}}</code>; fenced code blocks are protected automatically.

How should version availability markers be handled when a feature is enhanced?▼

Keep the original version marker on the base capability and add the new version only to the specific enhancement sub-item. Moving the whole section's marker to the newer version wrongly implies the base feature was previously unavailable.

When should a feature be mentioned in the README versus the docs site?▼

Reserve README mentions for user-facing features important at the project overview level, keeping the copy short and product-level. Detailed usage belongs in the docs site, and version availability belongs in docs pages or release notes, never in the README.

Related Skills

Explore More Content & Communication Skills→
enitratenitrat
15

ask-questions-if-underspecified

Clarify underspecified requests with 1–5 prioritized questions before implementation.

Community
Intermediate
jhlee0409jhlee0409
7

afc:release-notes

Generate categorized release notes from git commits and pull requests.

Community
Advanced
gobifrostgobifrost
55

bifrost-documentation

Refresh gobifrost documentation with screenshots, MDX pages, and pull requests.

Official
Advanced
kirvinkirvin

documentation

Generate and refine technical documentation, including code comments and API references.

Community
Intermediate