OpenParable
Skip to content
← Back to skills

Weapp Vite Website Curator

Documents
weapp-vite-website-curator

Weapp Vite Website Curator is an Agent Skill for documents published in the weapp-vite/weapp-vite repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Maintain and enrich weapp-vite website docs from packages source of truth. Use when updating `website/` content based on `packages/*` code or README, adding package docs pages, syncing VitePress nav/sidebar, or validating package-to-doc coverage after package changes.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/weapp-vite/weapp-vite/blob/HEAD/maintainers/skills/weapp-vite-website-curator/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/weapp-vite-website-curator, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

weapp-vite-website-curator

Overview

Keep website/ aligned with packages/* as the source of truth. Prefer minimal, verifiable edits that improve discoverability and prevent docs drift.

Workflow

  1. Inventory packages
  • Read packages/*/package.json to identify public package name, description, and exports/bin.
  • Read packages/*/README.md and only the needed source entry files (for example src/index.ts) to verify available APIs.
  1. Detect website coverage gaps
  • Check website/packages/ and website/.vitepress/config.ts for existing pages and sidebar entries.
  • Mark missing pages, stale API examples, and broken navigation links.
  1. Update docs pages
  • Write or update website/packages/*.md pages.
  • Keep each page focused on: positioning, when to use, install, minimal usage, and links.
  • Prefer statements that can be traced to README or exported APIs.
  1. Sync navigation
  • Update packagesSidebarItems in website/.vitepress/config.ts.
  • Keep top nav package entry pointing to an overview page (usually /packages/).
  • Keep bilingual pages grouped when both language versions exist.
  1. Verify
  • Run pnpm build inside website/ after docs changes.
  • Fix unresolved links or route errors before finishing.

Quality Rules

  • Use package code and README as authoritative sources.
  • Avoid undocumented claims and speculative roadmap items.
  • Keep examples minimal and executable.
  • Use Chinese for zh-oriented pages unless the page is explicitly English.
  • Prefer adding overview pages before deep pages when scope is broad.

References

  • Use references/page-template.md when creating new package pages.
  • Use references/review-checklist.md before finalizing changes.