一键导入
document-feature
Create or update user-facing documentation for Sayr features in apps/marketing
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
菜单
Create or update user-facing documentation for Sayr features in apps/marketing
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
| name | document-feature |
| description | Create or update user-facing documentation for Sayr features in apps/marketing |
| metadata | {"audience":"developers","workflow":"documentation"} |
When you implement or update a public-facing feature, I help create or update user documentation in apps/marketing/src/content/docs/.
I will:
docs/index.md Browse by Topic table when adding new pagesDocs live in apps/marketing/src/content/docs/docs/ with this organization:
index.md - Main documentation landing page (includes a "Browse by Topic" table)quick-start.md - Getting started guidefeatures/*.md - Core product features (tasks, labels, categories, templates, subtasks, relations)guides/*.md - Feature guides and workflow how-tos (visibility, views, releases, public pages)organizations/*.md - Organization management (members, teams, integrations)api/*.md - API documentationself-hosting/*.md - Deployment and self-hosting guidesknowledge-base/*.md - FAQ and troubleshooting| New content type | Where it goes |
|---|---|
| Product feature (what a thing is and how to use it) | features/ |
| Organization settings or management page | organizations/ |
| Third-party integration | organizations/ |
| Self-hosting or deployment | self-hosting/ |
| FAQ or troubleshooting | knowledge-base/ |
The sidebar in apps/marketing/astro.config.mjs uses autogenerate for all sections — Features, Organizations, Self Hosting, and Contributing. Files added to the correct directory automatically appear in the right section.
| Section | Directory |
|---|---|
| Features | docs/features/ |
| Organizations | docs/organizations/ |
| Self Hosting | docs/self-hosting/ |
| Contributing | docs/contributing/ |
Control the order and label of each page using the sidebar frontmatter:
---
title: Your Feature
description: Brief description
sidebar:
order: 7
label: Custom Label # optional — defaults to title
---
Every documentation file must include this frontmatter:
---
title: Feature Name
description: Brief description of what this page covers (used in SEO)
sidebar:
order: N
---
##) for main sections, H3 (###) for subsectionsindex.md - When adding a new page, add it to the Browse by Topic table in docs/index.mdUse this skill when:
Tell me:
For a new core feature like "Notifications", I would create apps/marketing/src/content/docs/docs/features/notifications.md:
---
title: Notifications
description: Stay informed when tasks you care about are updated
sidebar:
order: 7
---
# Notifications
Sayr sends you notifications when things change on tasks you're involved with.
## When You're Notified
- You're assigned to a task
- A task you created or are assigned to changes status or priority
- Someone @mentions you in a comment
- A comment is posted on a task you're watching
## Managing Notifications
...
Then add it to the Browse by Topic table in docs/index.md.
The page will appear automatically in the Features sidebar section because autogenerate scans docs/features/. The sidebar.order: 7 frontmatter controls its position.
基于 SOC 职业分类
Work with the Sayr edition system (cloud, community, enterprise) including limits, capabilities, and edition-aware code
Add, remove, or modify commands and sub-views in the Cmd+K command palette
Add or modify PageHeader layouts on admin pages, including task view integration and cross-org patterns
Add, modify, or troubleshoot the right sidebar panel on admin pages
Update GitHub pull request title and description with comprehensive summary