content-editing

Automate InfluxData documentation editing and validation workflows with the docs CLI.

80|330|Updated Dec 13, 2018
One-click install
npx skills add https://github.com/influxdata/docs-v2 --skill content-editing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: content-editing
Source: https://github.com/influxdata/docs-v2/tree/main/.claude/skills/content-editing
Command: npx skills add https://github.com/influxdata/docs-v2 --skill content-editing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Content editing for InfluxData documentation is a comprehensive, multi-step process that includes drafting, reviewing, testing, and coordinating across multiple content trees. This Skill provides a structured workflow to streamline these activities, improve consistency, and reduce manual handoffs.

Core Features & Use Cases

  • Guided workflow for creating new docs, editing existing content, and validating changes across product pages and references.
  • Integration with the docs CLI, shared content management patterns, and testing steps (Hugo builds, link validation, code-block testing, and end-to-end checks).
  • Use Case: A content editor drafts a new guide, updates related references, validates formatting and links, and publishes with confidence.

Quick Start

  • docs create <draft-path> --products influxdb3-core
  • docs edit <url-or-path>
  • hugo --quiet

Frequently Asked Questions about content-editing

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

FAQPage Schema
How do I automate InfluxData documentation editing and validation?

Automate InfluxData documentation editing by using a structured workflow that guides drafting, testing, and publishing across multi-product content trees with the docs CLI. It integrates Hugo builds, link validation, and code-block testing to streamline the process.

What is the best way to validate links and code blocks when editing docs?

The best way to validate links and code blocks during content editing is through integrated testing pipelines. This workflow runs Hugo builds, link validation, and end-to-end checks automatically to ensure formatting and references are correct before publishing.

Do I need the docs CLI to manage multi-product content trees?

Yes, you need the docs CLI to manage multi-product content trees effectively. The content editing workflow requires the docs CLI, shared content patterns, and testing pipelines to function and coordinate updates across product pages.

How does MCP-based fact-checking work for documentation?

MCP-based fact-checking works by validating content accuracy automatically within the editing workflow. It integrates with the docs CLI to guide drafting and reviewing, ensuring documentation remains factually correct across multiple product references.

Can I use this workflow to draft and publish new InfluxDB guides?

Yes, you can use this workflow to draft and publish new InfluxDB guides. A content editor can create drafts using the docs CLI, update related references, validate formatting, and execute end-to-end checks to publish with confidence.

What are the limitations of relying on docs CLI for content editing?

A limitation of relying on the docs CLI for content editing is its strict dependency on shared content patterns and specific testing pipelines. Without these required components and the Hugo build environment, the automated validation workflow cannot function properly.