preview

What This Skill Does

The preview skill acts as a dedicated documentation engineering assistant for SpecWeave projects, leveraging Docusaurus to provide an interactive, high-fidelity documentation experience. It automates the entire lifecycle of your project's living documentation, managing environments, dependencies, and deployment configurations without requiring manual setup. By utilizing a local cached environment within the .specweave/cache directory, the skill ensures that subsequent launches are instantaneous, providing a seamless development flow. The skill features robust hot-reloading, meaning every change made to your markdown files is reflected in the browser in real-time, drastically reducing the feedback loop when writing technical specifications. Furthermore, it includes built-in support for Mermaid diagrams, allowing you to visualize complex system architectures directly within your browser window. By automatically generating sidebars based on your file structure, the skill eliminates the need for manual configuration files, allowing you to focus purely on content creation.

Installation

To integrate this documentation expert into your OpenClaw environment, use the following command: clawhub install openclaw/skills/skills/anton-abyzov/sw-preview Once installed, the skill automatically detects SpecWeave project structures and manages the .specweave/cache directory independently. No additional configuration is required to initiate the first preview.

Use Cases

This skill is ideal for software architects, technical leads, and developers who need to maintain living documentation that evolves alongside their code. It is perfectly suited for teams that require both internal-facing documentation (containing sensitive architectural details) and public-facing developer portals. Use it to draft project proposals, document API endpoints with interactive diagrams, or build static documentation sites ready for production deployment using the /sw-docs:build command.

Example Prompts

1. "I'm working on the new module documentation, can you launch the preview server so I can see my changes?"
2. "Please build my internal documentation as a static site so I can prepare it for deployment."
3. "Open the public documentation server in my browser so I can review the latest API guides."

Tips & Limitations

To ensure optimal performance, keep your documentation files organized within the .specweave/docs/internal or .specweave/docs/public folders. If you encounter port conflicts, use the provided lsof commands to clear the ports before restarting the server. Note that the initial setup for a new project takes approximately 30 seconds due to dependency installation, but this is cached automatically. Always run the build command if you intend to move your docs from a local preview to a production hosting environment.