Skip to content

Fine-tune the auto-generated skill.md #20

Description

@so0k

Background

Mintlify auto-generates an agent skill file at https://cdktn.io/docs/skill.md (agentskills.io spec) by analyzing the published docs. It's a capability descriptor — what an agent can accomplish with CDKTN, key commands, and constraints — complementing the MCP server and llms.txt.

We now point agents at it from the new AI Agents (MCP) docs page (#19) and from the landing-site llms.txt. Since it's referenced publicly, the auto-generated content is worth reviewing and refining.

Goal

Review the current auto-generated skill.md and decide whether to override it with a curated version for deterministic, higher-quality output.

Per the Mintlify guidance (mintlify.com/docs/ai/skillmd):

  • Override auto-generation by committing a custom skill.md at the docs project root, or
  • Manage multiple skills under .mintlify/skills/ with a SKILL.md per subdirectory.
  • Custom files require YAML frontmatter: name, description, license, compatibility.
  • Note: auto-generation only runs for public sites and can take up to 24h to refresh; a committed custom file is immediate and stable.

Things to check / fix in the current output

  • name is Cdkterrain — set a clean, conventional identifier (e.g. cdktn / kebab-case) with proper casing.
  • CDKTF association — make explicit that CDKTN is the maintained community successor to the deprecated HashiCorp CDKTF (CDK for Terraform / Terraform CDK), so agents route CDKTF/Terraform-CDK questions here.
  • Verify CLI accuracy — the generated ## Quick Reference lists cdktn init/get/synth/deploy/...; confirm the actual binary name and flags against cli-reference/commands.
  • Key files — confirm cdktf.json, entry points, and .gen/ descriptions match current CDKTN behavior.
  • Add license (MPL-2.0) and compatibility frontmatter if committing a custom file.
  • Review the generated skills/workflows sections for correctness and trim anything inaccurate.

References

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions