Skip to content

docs(contribs): add description field to all contribs YAML files#151

Draft
httpdss wants to merge 1 commit into
mainfrom
feature/add-descriptions-to-contribs-yaml
Draft

docs(contribs): add description field to all contribs YAML files#151
httpdss wants to merge 1 commit into
mainfrom
feature/add-descriptions-to-contribs-yaml

Conversation

@httpdss
Copy link
Copy Markdown
Owner

@httpdss httpdss commented May 26, 2026

Problem

The YAML files under structkit/contribs/ had no description field, making it impossible to quickly understand what each structure generates without reading its full content.

Solution

Added a top-level description: > field to every YAML file under structkit/contribs/, consistent with common StructKit conventions. Each description provides a concise, human-readable summary of what the structure creates or configures.

Changes

Added description to all 46 YAML files across:

  • Root-level structures (ansible-playbook, chef-cookbook, ci-cd-pipelines, cloudformation-files, docker-files, documentation-template, git-hooks, helm-chart, kubernetes-manifests, vagrant-files)
  • configs/ (chglog, codeowners, devcontainer, editor-config, eslint, jshint, kubectl, prettier)
  • github/chatmodes/ (plan)
  • github/instructions/ (generic)
  • github/prompts/ (generic, react-form, security-api, struct)
  • github/templates
  • github/workflows/ (codeql, execute-tf-workflow, labeler, pre-commit, release-drafter, run-struct, stale)
  • project/ (custom-structures, generic, go, java, n8n, nodejs, python, ruby, rust)
  • prompts/ (run-struct-trigger)
  • terraform/apps/ (aws-accounts, environments, generic, github-organization, init)
  • terraform/modules/ (generic)

Testing

  • All pre-commit hooks (check-yaml, end-of-file-fixer, trailing-whitespace) passed
  • No existing structure content was modified, only descriptions were prepended

Add a top-level description field to every YAML file under structkit/contribs/
to provide a quick summary of what each structure generates or configures.
@httpdss httpdss added documentation Improvements or additions to documentation minor and removed feature minor labels May 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant