learn-site-structure

Name: learn-site-structure
Availability: InStock
Author: netdata

Analyze and manage the documentation pipeline for publishing source repository content to the Netdata learn site.

80.4k|6.6k|Updated Jun 17, 2013

Search Tags:#pipeline #netlify #docusaurus #Documentation #redirects #ingest #Netdata

Ready to run

npx skills add https://github.com/netdata/netdata --skill learn-site-structure

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides an authoritative reference for the complex, multi-repo documentation pipeline that powers learn.netdata.cloud, preventing errors when adding, moving, or deleting documentation pages.

Core Features & Use Cases

Source-of-Truth Management: Understands the map.yaml hierarchy that dictates site structure and URL routing.
Pipeline Orchestration: Explains the 16-step ingest.py process, including metadata injection, MDX sanitization, and redirect generation.
Authoring Guidance: Provides clear boundaries on where to edit content (source repo vs. learn repo) and how to handle redirects for page deletions.

Quick Start

Use the learn-site-structure skill to determine the correct repository and map.yaml configuration for adding a new documentation page.

Frequently Asked Questions about learn-site-structure

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

FAQPage Schema

How do I add a new documentation page to the Learn site?▼

Add the new markdown file to the appropriate source repository and include a corresponding node in the `docs/.map/map.yaml` file within the `netdata/netdata` repository.

Should I edit documentation in the learn repo or the source repo?▼

Edit documentation content in the source repository (e.g., `netdata/netdata`). The learn repository is primarily for site configuration, build logic, and hand-authored exceptions marked with `part_of_learn: True`.

How are redirects handled when I move or rename a page?▼

Moving or renaming a page in `map.yaml` triggers an automatic redirect generation during the next ingest cycle, which updates the dynamic redirect section in `netlify.toml`.

Why is my documentation page not appearing on the Learn site?▼

Pages are only published if they are explicitly declared in `docs/.map/map.yaml`. Ensure your page has a corresponding node in the map and that the `edit_url` matches the source file.

What are the limitations of the redirect mechanism?▼

Netlify has a limit of approximately 10,000 redirect rules per site. Because the dynamic redirect catalog grows with every ingest, it is approaching this ceiling and requires periodic pruning.