docs-cli-workflow

Guides choosing between docs create and docs edit CLI tools for InfluxData documentation workflows.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps content teams decide when to use the docs create/edit CLI tools versus direct file editing, streamlining authoring workflows and preserving conventions.

Core Features & Use Cases

  • Decision guidance on whether to scaffold new pages with docs create or modify existing ones with docs edit.
  • Contextual prompts that surface style guidelines, shortcode examples, and content localization considerations.
  • Use Case: When a draft references multiple product sections, the Skill recommends the CLI scaffolding to ensure consistent structure and metadata.

Quick Start

Example: I have a new page draft for /influxdb3/core/admin/, should I use docs create or docs edit?

Frequently Asked Questions about docs-cli-workflow

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

FAQPage Schema
When should I use the docs CLI instead of editing files directly?

Use the docs CLI instead of direct edits when drafting new pages or modifying existing content to ensure consistent structure, metadata, and adherence to documentation conventions.

How do I decide between docs create and docs edit for my workflow?

Choose docs create to scaffold new pages for consistent structure, and docs edit to modify existing content, using decision criteria and contextual prompts to guide the workflow.

What is the best way to map URLs to source files in documentation?

The docs CLI workflow provides guidance to map URLs to source files, ensuring you correctly target content for modifications across the documentation structure.

Does the docs CLI workflow provide guidance on style guidelines and shortcodes?

Yes, the docs CLI workflow surfaces contextual prompts that include style guidelines, shortcode examples, and content localization considerations during the creation and editing process.

Can I use direct file editing for drafts that reference multiple product sections?

For drafts referencing multiple sections, the workflow recommends using the CLI scaffolding approach rather than direct edits to maintain consistent structure and metadata across pages.