markdesk-docs

📁 charlieclark/markdesk 📅 14 days ago
1
总安装量
1
周安装量
#76173
全站排名
安装命令
npx skills add https://github.com/charlieclark/markdesk --skill markdesk-docs

Agent 安装分布

amp 1
opencode 1
kimi-cli 1
codex 1
github-copilot 1
claude-code 1

Skill 文档

Markdesk Docs Skill

You are helping the user create help center content (articles and/or product updates) for their Markdesk-powered help center.

Step 1: Gather Context

Look for the user’s main project repository (not the help center) and run:

git log --oneline -30

Show the user the recent commits and ask which changes they want to document. If they want details on specific commits, use git show <hash>.

Step 2: Ask Content Type

Use AskUserQuestion to ask:

What type of content do you want to create?

  • Help article — Documentation explaining how to use a feature
  • Product update — Changelog entry announcing a change
  • Both — Create both a help article and a product update

Step 3: Ask About Images

Ask if the user has any screenshots or images to include. Users can:

  • Drag and drop images directly into the chat — the image path will be provided (e.g. /Users/name/Desktop/screenshot.png)
  • Provide file paths to existing images on disk

When the user provides images (via drag-and-drop or path):

  1. Copy each image to the appropriate directory in the help center project:
    • Articles: public/images/articles/
    • Updates: public/images/updates/
  2. Rename to a clean slug-based filename: {slug}-{number}.{ext} (e.g., my-feature-1.png)
  3. Reference in markdown as ![Alt text](/images/articles/{slug}-1.png) or ![Alt text](/images/updates/{slug}-1.png)

Important — macOS screenshot filenames: macOS screenshots have spaces in the filename (e.g. Screenshot 2026-02-13 at 12.17.27 PM.png). Always quote the source path when copying:

cp "/Users/name/Desktop/Screenshot 2026-02-13 at 12.17.27 PM.png" public/images/updates/my-feature-1.png

Step 4: Category Selection (for articles)

If creating a help article, read the categories from src/lib/categories.ts in the help center project dynamically. Do NOT hardcode category names.

Use AskUserQuestion to ask:

  1. Which category should this article belong to?
  2. Should it appear in the FAQ section? (faq: true)

Step 5: Generate Help Article

Create the file at content/articles/{category}/{slug}.md in the help center project.

Frontmatter format:

---
title: "Article Title"
slug: "article-slug"
category: "category-slug"
description: "Short description for search and previews."
order: 99
faq: false
createdAt: "YYYY-MM-DD"
updatedAt: "YYYY-MM-DD"
---

Rules:

  • Unique slug — Check existing articles to avoid duplicate slugs
  • No h1 — Do NOT include an # h1 heading in the body (the title is rendered from frontmatter)
  • Today’s date — Use today’s date for createdAt and updatedAt
  • Clear writing — Write in a clear, concise, helpful tone
  • Practical content — Include step-by-step instructions where appropriate
  • Images — Reference as /images/articles/filename.png

Step 6: Generate Product Update

Create the file at content/updates/YYYY-MM-DD-{slug}.md in the help center project.

Frontmatter format:

---
title: "Update Title"
slug: "update-slug"
date: "YYYY-MM-DD"
category: "new"
showModal: true
---

Rules:

  • Date in filename — Use today’s date in the filename: YYYY-MM-DD-{slug}.md
  • Category — One of: new, improvement, fix, announcement, coming-soon
  • showModal — Set to true to show as a popup notification in the beacon widget
  • Concise — Keep updates brief and focused on what changed and why it matters
  • No duplicate images — If an image appears in the content body, don’t repeat it

Step 7: Verify

After creating the content:

  1. List the files created
  2. Show the frontmatter for each
  3. Remind the user to run npm run build in the help center to regenerate the search index and content