Communitygithub.com

LobeHub 文档撰写

用于 LobeHub 公共网站 `docs/**` 目录下的文档撰写,包括自托管、部署、迁移和配置指南。不包括产品更新日志和源码 API 文档。

LobeHub 文档撰写 是什么?

该技能专为 LobeHub 公共网站的文档撰写设计,适用于 `docs/**` 路径下的所有内容,包括自托管、部署、迁移和配置指南,但不涉及产品更新日志或源码 API 文档。它在多个 AI 代理平台(如 Claude Code、Cursor、Codex)中均可使用。该技能强调遵循统一的设计规范,在撰写前必须阅读 `../../../DESIGN.md` 中的“语气与内容”部分,并针对自托管文档参考特定受众指南。它要求所有文档内容必须基于当前代码进行验证,包括命令、默认值、限制和回滚行为,以确保准确性。技能建议采用单一规范页面、推荐路径、简短可执行的步骤和可见的验证结果,同时保持中英文版本一致。对于路径变更,需更新内部链接并添加经过测试的永久重定向,以保留语言前缀和查询参数。每次修改后需运行针对性的文档检查。对于 `docs/changelog/**` 路径,则需改用 `../docs-changelog/SKILL.md`。

兼容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/lobehub/lobehub/tree/HEAD/.agents/skills/write-landing-docs

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

撰写落地文档

  • 公共网站文档撰写于 docs/** 目录下。
  • 起草前请阅读 ../../../DESIGN.md 中的“语气与内容”部分。
  • 对于 docs/self-hosting/**,请参考 默认受众。
  • 根据当前代码验证声明、默认值、命令、限制和回滚行为。
  • 优先使用单一规范页面、推荐路径、简短可执行的步骤以及可见的验证结果。保持英文和简体中文版本一致。
  • 如果发布路径发生更改,请更新内部链接,并在落地仓库中添加经过测试的永久重定向,该重定向需保留语言前缀和查询参数。
  • 对每个更改的页面运行针对性的文档检查。

对于 docs/changelog/**,请改用 ../docs-changelog/SKILL.md。

Individual skills in this repo

This repo contains 19 individual skills — each has its own dedicated page.

lobehub/add-provider-doc

Add documentation for a new AI provider — usage docs, env vars, Docker config, image resources.

lobehub/add-setting-env

Add server-side environment variables that control default values for user settings.

lobehub/debug

Debug package usage guide. Use when adding debug logging, understanding log namespaces, or implementing debugging features. Triggers on debug logging requests or logging implementation.

lobehub/desktop

Electron desktop development guide — IPC handlers, controllers, preload scripts, window/menu management.

lobehub/drizzle

LobeHub Drizzle ORM schema and query style. Use for pgTable schemas, indexes, joins, inferred types, db.select/db.query, schema fields, foreign keys, junction tables, or postgres query patterns.

lobehub/hotkey

Add or edit LobeHub keyboard shortcuts. Use for HotkeyEnum, HOTKEYS_REGISTRATION, combineKeys, useHotkeyById, tooltip hotkeys, shortcut scope, conflicts, or Cmd/Ctrl key combos.

lobehub/i18n

LobeHub i18n with react-i18next. Use for user-facing strings, locale keys, namespaces, useTranslation, t(), interpolation, zh-CN/en-US previews, hardcoded UI copy, or pnpm i18n.

lobehub/linear

Linear issue management. Use for LOBE-xxx issues, Linear links, PRs referencing Linear, retrieving issues, updating status, completion comments, or sub-issue trees.

lobehub/microcopy

UI copy and microcopy guidelines. Use for user-facing copy, buttons, errors, empty states, onboarding, i18n wording, translation, or copy improvements in Chinese or English.

lobehub/modal

LobeHub imperative modal conventions. Use when creating or migrating modals, dialogs, popups, confirm flows, ModalHost wiring, createModal, confirmModal, useModalContext, or base-ui modal APIs.

lobehub/pr

Create a PR for the current branch (targets `canary` by default), including splitting one cross-layer branch into ordered stacked PRs so a lower layer (db / shared package / server TRPC) merges before its callers (desktop / CLI / UI). Use when the user asks to create / submit a PR, or to split a branch because clients call a server contract that isn't on the trunk yet. Triggers on 'pr', 'create pr', 'submit pr', 'open a PR', 'pull request', 'split this PR', 'stacked PR', 'backend should merge first', '提 PR', '提个 PR', '新建 PR', '拆 PR', '后端先合', '分层合并'.

lobehub/project-overview

LobeHub open-source monorepo architecture map. Use when locating code layers, understanding apps/packages/src layout, business stubs, project structure, or onboarding to the repository.

lobehub/react

LobeHub React component conventions. Use when editing TSX UI, choosing base-ui vs @lobehub/ui vs antd, styling with antd-style, routing, desktop variants, layouts, or component state.

lobehub/store-data-structures

LobeHub Zustand store data-shape patterns. Use when designing store state, list/detail splits, normalized maps, reducers, messagesMap, topicsMap, or choosing shared type sources.

lobehub/testing

Vitest testing guide. Use when writing or updating tests, fixing failing tests, improving coverage, debugging test issues, or setting up mocks.

lobehub/typescript

LobeHub TypeScript style and type-safety guide. Use when editing TS/TSX/MTS, fixing types, choosing interface vs type, avoiding any/object, import type, async flow, or ts-expect-error.

lobehub/upstash-workflow

LobeHub Upstash Workflow and QStash guide. Use for async workflows, process/paginate/execute fan-out, serve handlers, context.run/call/sleep, or workflow triggers.

lobehub/version-release

Version release workflow — release process and GitHub Release notes (not docs/changelog pages).

lobehub/zustand

LobeHub Zustand store conventions. Use when editing src/store, store slices, public/internal actions, dispatch actions, flattenActions, optimistic updates, selectors, maps, or class action migration.

相关技能