Skip to main content

doc-feature

Create or update feature documentation in the Astro Starlight docs site. Use when adding new features or updating existing documentation.

설치로 이동

소스 정보

저장소
ahembree/librariarr
최근 소스 활동
2026년 5월 20일 21:23
감지된 SKILL.md 언어
영어
스타
5
포크
1

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
name
doc-feature
description
Create or update feature documentation in the Astro Starlight docs site. Use when adding new features or updating existing documentation.
argument-hint
<feature-name> [new|update]
# Documentation Generator Create or update documentation for: $ARGUMENTS ## Context The docs site is **completely isolated** from the Next.js app: - Built with Astro + Starlight, deployed to GitHub Pages at librariarr.dev - Separate `package.json`, `tsconfig.json`, build toolchain - MDX files at `docs/src/content/docs/docs/` - Sidebar configured in `docs/astro.config.mjs` ## Directory Structure ``` docs/src/content/docs/docs/ getting-started/ — Installation, configuration, server setup features/ — Dashboard, library, lifecycle rules, stream manager, etc. integrations/ — Sonarr, Radarr, Lidarr, Seerr, Plex, Jellyfin/Emby advanced/ — Development guide ``` ## MDX File Format ```mdx --- title: Feature Name description: Brief description for SEO and link previews. --- Content here using standard Markdown. ## Section Heading Use Starlight components for rich content: - `:::note` / `:::tip` / `:::caution` / `:::danger` — callout boxes - `import { Tabs, TabItem } from '@astrojs/starlight/components';` — tabbed content - `import { Steps } from '@astrojs/starlight/components';` — numbered steps ``` ## Sidebar Configuration New pages must be added to `docs/astro.config.mjs`: ```javascript // In the sidebar array, under the appropriate section: { label: "Features", items: [ // ... existing items { label: "New Feature", slug: "docs/features/new-feature" }, ], }, ``` The `slug` must match the file path relative to `docs/src/content/docs/` without the `.mdx` extension. ## Existing Sidebar Sections - **Getting Started**: installation, configuration, connecting-a-server - **Features**: dashboard, library, lifecycle-rules, stream-manager, preroll-manager, backup-restore, notifications, system-logs - **Integrations**: plex, jellyfin-emby, sonarr, radarr, lidarr, seerr - **Advanced**: development, security-hardening, sso ## Steps ### For new documentation pages: 1. Create MDX file at `docs/src/content/docs/docs/<category>/<name>.mdx` 2. Add frontmatter with `title` and `description` 3. Write content covering: what the feature does, how to configure it, key options 4. Add sidebar entry in `docs/astro.config.mjs` under the correct section 5. Verify: `pnpm docs:build` (catches broken links/formatting) ### For updating existing pages: 1. Find the existing MDX file in `docs/src/content/docs/docs/` 2. Update content to reflect changes 3. Verify: `pnpm docs:build`
GitHub에서 보기