Why
The plugin has no live demo or documentation site, making it hard for potential users to evaluate it. A GitHub Pages site built with VitePress — and powered by the plugin itself using the repository's own OpenAPI spec as the example — serves as both public documentation and a living proof-of-concept that the plugin works end-to-end.
What Changes
- A
docs/directory is added containing a minimal VitePress site configuration - The repository's own OpenAPI spec (e.g.
openspec/petstore.yamlor a dedicateddocs/api/openspec.yaml) is wired into the VitePress site via the plugin - A GitHub Actions workflow (
.github/workflows/deploy-docs.yml) builds and deploys the site to GitHub Pages on every push tomain package.jsongainsdocs:devanddocs:buildscripts for local development of the demo site
Capabilities
New Capabilities
vitepress-site: Adocs/VitePress site configuration that usesvitepress-plugin-openspecto render the bundled example spec, with a sidebar and nav entry for the API reference sectiongithub-actions-deploy: A GitHub Actions workflow that installs dependencies, builds the VitePress site, and deploys the output to GitHub Pages using the officialactions/deploy-pagesaction
Modified Capabilities
(none)
Impact
- New directory:
docs/(VitePress source) - New file:
.github/workflows/deploy-docs.yml package.json— two new scripts (docs:dev,docs:build)- No changes to plugin source code (
src/) - Requires GitHub Pages enabled on the repository (Settings → Pages → Source: GitHub Actions)