skills.rest
mysticaltech
mysticaltechCOMMUNITY
Explore all skills by this author →
𝕏@mysticaltechGitHub

sync-docs

Synchronize variables.tf, llms.md, kube.tf.example, and README when variables change.

3.9k|557|Updated Jul 30, 2021
Search Tags:#automation#documentation#readme#variables#docs-sync#llms.md#kube.tf.example
One-click install
npx skills add https://github.com/mysticaltech/terraform-hcloud-kube-hetzner --skill sync-docs-mysticaltech
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/mysticaltech/terraform-hcloud-kube-hetzner/tree/main/.claude/skills/sync-docs
Command: npx skills add https://github.com/mysticaltech/terraform-hcloud-kube-hetzner --skill sync-docs-mysticaltech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift across critical files can cause inconsistencies between variable definitions and their usage in documentation and examples. This skill keeps variables.tf, llms.md, kube.tf.example, and README aligned automatically.

Core Features & Use Cases

  • Automated consistency checks between variables.tf and llms.md.
  • Propagation of updates to llms.md and kube.tf.example when variables change.
  • Use Case: When a new variable is added or an existing one is updated, sync-docs updates the docs and examples accordingly.

Quick Start

Run the sync-docs workflow to align variables.tf, llms.md, kube.tf.example, and README.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I keep Terraform variables.tf documentation in sync with README and examples?▼

To keep Terraform variables.tf documentation in sync, you can automate the synchronization of variable definitions across llms.md, kube.tf.example, and README files to prevent documentation drift when variables change.

Why does my README documentation drift when I add new variables to variables.tf?▼

Documentation drift happens because manually updating README files after adding variables to variables.tf is error-prone, but automating documentation synchronization propagates variable updates to llms.md and kube.tf.example automatically.

What's the best way to automate documentation updates for new Terraform variables?▼

The best way to automate documentation updates for new Terraform variables is running a sync workflow that aligns variables.tf, llms.md, kube.tf.example, and README whenever new variables or options are introduced.

Can I automatically update kube.tf.example when variables.tf changes?▼

Yes, you can automatically update kube.tf.example when variables.tf changes by applying a documentation synchronization workflow that aligns code examples with the latest variable definitions.

Does documentation sync work with llms.md and variables.tf without external dependencies?▼

Yes, documentation sync works with llms.md and variables.tf without external dependencies, running automated consistency checks and propagating updates across README and kube.tf.example natively.

When should I not use automated docs synchronization for my project files?▼

You should not use automated docs synchronization if your project lacks the specific files like variables.tf, llms.md, kube.tf.example, or README, as the workflow is tailored to align these exact file types.

Related Skills

Explore More Content & Communication Skills→
DexploarerDexploarer
6

terraform-module-builder

Generate production-ready Terraform modules for AWS, Azure, or GCP deployments.

Community
Advanced
armanzeroeightarmanzeroeight
29

terraform-documentation-generator

Generate Terraform module README files with terraform-docs.

Community
Intermediate
auldsyababuaauldsyababua
6

markdown-validation

Validate Markdown files for syntax, links, and formatting standards.

Community
Advanced
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced