fluentplayer-review-docs

スター0

フォーク0

更新日2026年6月5日 09:20

Pre-publish audit of the FluentPlayer VitePress docs (fluentplayer-user-docs). Runs docs:build to catch dead links, checks every guide page is wired into the guideGroups sidebar, flags Pro features missing a (Pro) label, verifies screenshot references resolve to files on disk (and finds orphans), catches known alt-text/spelling typos, and flags empty/placeholder pages. Produces a structured report and offers fixes. USE FOR: review the docs, lint docs, pre-publish check, audit the documentation, find broken links, check the sidebar, before committing docs. DO NOT USE FOR: creating a new page (use fluentplayer-add-doc-page) or writing content.

インストール

Codex または Claude でインストールこの Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。

ソース

WPManageNinja

WPManageNinja/fluentplayer-user-docs

GitHub リポジトリを開く Creator のリポジトリを見る

ダウンロード

Review the FluentPlayer docs

A read-only audit pass over the docs site. Gather findings first, present a structured report, then offer to apply fixes — do not auto-edit content without the user's go-ahead.

Agent behavior rules

DO run every check below and report all findings, even when the build passes.
DO present findings before editing; apply fixes only after the user confirms.
DO keep the analysis in the sandbox (process files in code, surface only the summary) to avoid flooding context.
DO NOT treat a passing docs:build as a full pass — link health is only one of the checks.
DO NOT change product meaning when fixing typos; fix spelling/labels only.

Checks

1. Dead links (build gate)

Run npm run docs:build. VitePress fails on dead internal links. Capture and report any dead-link errors verbatim (file + target). A clean build = links resolve.

2. Sidebar sync

The sidebar is hand-wired in .vitepress/config.mts (guideGroups). Cross-check it against the filesystem:

Collect every page route from guide/**/*.md (a file guide/<section>/<slug>.md → /guide/<section>/<slug>; index.md → /guide/<section>/). Exclude changelog.md and support.md if intentionally nav-only.
Collect every link in guideGroups.
Report pages not in the sidebar (reachable by URL but invisible) and sidebar links with no file (dead entries).

3. Free/Pro labeling

For each page whose body clearly describes a Pro-only feature (mentions "Pro", "requires FluentPlayer Pro", or a Pro integration like Mux/Bunny/Mailchimp/Webhook/playlists/analytics), check that (Pro) appears in the # H1 and in its guideGroups sidebar text. Report mismatches. (This is a heuristic — present for human confirmation, don't auto-add.)

4. Screenshot references resolve

For every markdown image ![alt](/guide/public/...):

Confirm the referenced file exists on disk under guide/public/.... Report broken references.
Report orphaned images — files under guide/public/** (excluding .gitkeep) that no page references.
Confirm the extension is .webp (the repo convention); flag non-webp references.

5. Known typos / alt-text quality

Scan for the known existing typos and any obvious misspellings, e.g.:

Integrattions → Integrations
Singing Key → Signing Key
Sisibility → Visibility

Report each with file + line. Also flag empty or duplicated image alt text.

6. Placeholder / empty pages

Flag pages that are empty or stub-only — notably guide/changelog.md (currently empty) — and any page with a heading but no body.

Report format

Print a structured summary, grouped by check, e.g.:

docs:build .............. PASS (0 dead links)
Sidebar sync ............ 1 issue
  - guide/integrations/vimeo-integration.md not in guideGroups
Free/Pro labels ......... 0 issues
Screenshot refs ......... 2 issues
  - broken: /guide/public/settings/general/general-settings-9.webp (no file)
  - orphan: guide/public/integrations/mux/unused-12.webp
Typos ................... 1 issue
  - guide/integrations/webhook-integration.md:14  "Integrattions"
Placeholder pages ....... 1
  - guide/changelog.md (empty)

Then ask which fixes to apply. For typos and broken/orphaned-image cleanup, offer to fix directly. For sidebar gaps, offer to hand off to fluentplayer-add-doc-page (or add the missing leaf). For Free/Pro mismatches, confirm each with the user first.

このリポジトリの他の Skills

同じリポジトリ

audit-fluentplayer-docs

WPManageNinja/fluentplayer-user-docs

Run a read-only quality gate across the whole Fluent Player docs site: verify file placement, link form, sidebar coverage, image integrity, convention compliance, and a clean production build. Produces a scored pass/fail checklist with offending paths, then offers fixes. USE FOR: audit the docs, check for broken links, verify doc conventions, run the quality gate, is everything consistent, lint the docs, pre-commit doc check, find docs missing from the sidebar, find orphaned images. DO NOT USE FOR: writing a new page (use write-fluentplayer-doc), editing content (use edit-fluentplayer-doc), or renaming/moving/deleting (use restructure-fluentplayer-docs).

2026-06-120

edit-fluentplayer-doc

WPManageNinja/fluentplayer-user-docs

Edit the CONTENT of an EXISTING Fluent Player documentation page in place (same slug, same file location) while preserving every site convention. Handles wording changes, new/removed sections, updated steps, and swapped or added screenshots. USE FOR: edit the X doc, update the wording on, add a section to, rewrite this page, fix the screenshot in, this doc is out of date, correct an error in the doc, expand the X guide. DO NOT USE FOR: creating a new page (use write-fluentplayer-doc), renaming the slug / moving to another category / deleting / reordering the sidebar (use restructure-fluentplayer-docs), or site-wide audits (use audit-fluentplayer-docs).

2026-06-120

restructure-fluentplayer-docs

WPManageNinja/fluentplayer-user-docs

Perform STRUCTURAL operations on Fluent Player docs while protecting reference integrity: rename a doc (change its slug/URL), move a doc to another category, delete a doc, merge two docs, or reorder the sidebar. Always rewrites inbound links, moves the image folder, and updates guideGroups in config.mts. USE FOR: rename this doc, change the slug, change the URL of, move X to another category, delete this doc, remove this page, merge these two docs, reorder the sidebar, change the order of pages. DO NOT USE FOR: content/wording edits (use edit-fluentplayer-doc), creating a brand-new page (use write-fluentplayer-doc), or read-only audits (use audit-fluentplayer-docs).

2026-06-120

write-fluentplayer-doc

WPManageNinja/fluentplayer-user-docs

Create a NEW Fluent Player end-user documentation page in this VitePress site, correctly placed in a category folder and wired into the sidebar (guideGroups in config.mts). Optionally converts pasted HTML or raw markdown source into a clean doc. USE FOR: add a doc, write a new doc page, create a doc for X, document this feature, write a guide for, new documentation page, turn this content into a doc, import this article. DO NOT USE FOR: editing an existing page (use edit-fluentplayer-doc), renaming/moving/deleting a page or reordering the sidebar (use restructure-fluentplayer-docs), site-wide quality checks (use audit-fluentplayer-docs), or non-docs markdown like README.md / CLAUDE.md.

2026-06-120

fluentplayer-add-doc-page

WPManageNinja/fluentplayer-user-docs

Scaffold a new page in the FluentPlayer VitePress docs (fluentplayer-user-docs) following every repo convention: create the markdown file with frontmatter, create its screenshot directory + .gitkeep, wire it into the guideGroups sidebar in .vitepress/config.mts, apply (Pro) labels, and verify with docs:build. USE FOR: add a new doc page, create a guide page, new FluentPlayer doc, document a feature, add a page to the sidebar. DO NOT USE FOR: editing existing page prose, screenshots only (use fluentplayer-manage-screenshots), the changelog (use fluentplayer-changelog), or non-FluentPlayer repos.

2026-06-050

fluentplayer-changelog

WPManageNinja/fluentplayer-user-docs

Write and maintain the FluentPlayer docs changelog (guide/changelog.md in the fluentplayer-user-docs VitePress site). Scaffolds the page on first use (it is currently empty), then prepends a new reverse-chronological version section with user-facing Added/Changed/Fixed entries derived from release notes or git history. USE FOR: write a changelog entry, update the changelog, add a release note, document version X. DO NOT USE FOR: creating other doc pages (use fluentplayer-add-doc-page) or editing feature guides.

2026-06-050

name	fluentplayer-review-docs
description	Pre-publish audit of the FluentPlayer VitePress docs (fluentplayer-user-docs). Runs docs:build to catch dead links, checks every guide page is wired into the guideGroups sidebar, flags Pro features missing a (Pro) label, verifies screenshot references resolve to files on disk (and finds orphans), catches known alt-text/spelling typos, and flags empty/placeholder pages. Produces a structured report and offers fixes. USE FOR: review the docs, lint docs, pre-publish check, audit the documentation, find broken links, check the sidebar, before committing docs. DO NOT USE FOR: creating a new page (use fluentplayer-add-doc-page) or writing content.
license	MIT
compatibility	Operates on the fluentplayer-user-docs VitePress repo. Requires Node/npm and git.
metadata	{"project":"fluentplayer-user-docs"}

Review the FluentPlayer docs

A read-only audit pass over the docs site. Gather findings first, present a structured report, then offer to apply fixes — do not auto-edit content without the user's go-ahead.

Agent behavior rules

DO run every check below and report all findings, even when the build passes.
DO present findings before editing; apply fixes only after the user confirms.
DO keep the analysis in the sandbox (process files in code, surface only the summary) to avoid flooding context.
DO NOT treat a passing docs:build as a full pass — link health is only one of the checks.
DO NOT change product meaning when fixing typos; fix spelling/labels only.

Checks

1. Dead links (build gate)

Run npm run docs:build. VitePress fails on dead internal links. Capture and report any dead-link errors verbatim (file + target). A clean build = links resolve.

2. Sidebar sync

The sidebar is hand-wired in .vitepress/config.mts (guideGroups). Cross-check it against the filesystem:

Collect every page route from guide/**/*.md (a file guide/<section>/<slug>.md → /guide/<section>/<slug>; index.md → /guide/<section>/). Exclude changelog.md and support.md if intentionally nav-only.
Collect every link in guideGroups.
Report pages not in the sidebar (reachable by URL but invisible) and sidebar links with no file (dead entries).

3. Free/Pro labeling

4. Screenshot references resolve

For every markdown image ![alt](/guide/public/...):

Confirm the referenced file exists on disk under guide/public/.... Report broken references.
Report orphaned images — files under guide/public/** (excluding .gitkeep) that no page references.
Confirm the extension is .webp (the repo convention); flag non-webp references.

5. Known typos / alt-text quality

Scan for the known existing typos and any obvious misspellings, e.g.:

Integrattions → Integrations
Singing Key → Signing Key
Sisibility → Visibility

Report each with file + line. Also flag empty or duplicated image alt text.

6. Placeholder / empty pages

Flag pages that are empty or stub-only — notably guide/changelog.md (currently empty) — and any page with a heading but no body.

Report format

Print a structured summary, grouped by check, e.g.:

docs:build .............. PASS (0 dead links)
Sidebar sync ............ 1 issue
  - guide/integrations/vimeo-integration.md not in guideGroups
Free/Pro labels ......... 0 issues
Screenshot refs ......... 2 issues
  - broken: /guide/public/settings/general/general-settings-9.webp (no file)
  - orphan: guide/public/integrations/mux/unused-12.webp
Typos ................... 1 issue
  - guide/integrations/webhook-integration.md:14  "Integrattions"
Placeholder pages ....... 1
  - guide/changelog.md (empty)