learn-pr-preview

Build and inspect local documentation previews from pull request branches for validation.

80.4k|6.6k|Updated Jun 17, 2013

Search Tags:#preview #Documentation #pull-request #ingest #BUILD #Netdata

One-click install

npx skills add https://github.com/netdata/netdata --skill learn-pr-preview

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: learn-pr-preview
Source: https://github.com/netdata/netdata/tree/main/.agents/skills/learn-pr-preview
Command: npx skills add https://github.com/netdata/netdata --skill learn-pr-preview

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python3.13, node, yarn, rsync.

What problem does it solve?

This Skill solves the difficulty of verifying documentation changes in the Netdata Learn site without affecting the live production environment or requiring a full deployment cycle.

Core Features & Use Cases

Isolated Previewing: Creates a sandboxed environment to build and serve the Learn site from specific PR content.
Dependency Management: Automates the installation of ingest requirements and node dependencies for consistent builds.
Use Case: Use this when you have submitted a documentation PR and need to verify that your changes, including integration pages and metadata, render correctly before merging.

Quick Start

Run the learn-pr-preview skill to build and serve a local preview of the documentation from the current pull request.

Frequently Asked Questions about learn-pr-preview

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I preview my documentation changes locally?▼

Use the learn-pr-preview skill to build an isolated instance of the Learn site. It clones the repository, installs necessary dependencies, and serves the site locally on port 3030 for your inspection.

Does this skill affect the live Learn website?▼

No, the skill operates in an isolated directory under /tmp or the .local/ folder. It does not modify the production Learn checkout or the live site.

What should I check after building the preview?▼

Inspect the hand-authored pages you modified, verify generated integration pages, check the category index, and review any PR-specific warnings generated during the ingest process.

Why does the build process require specific Node versions?▼

The build process uses npx to pin specific versions of Node (22.14.0) and Yarn (1.22.22) to ensure the build environment matches the Netlify-pinned runtime used in production.