agentleFS
Sign inStart free
oocxoocx/tfplan2md/.agents/skills/generate-demo-artifacts/SKILL.md

generate-demo-artifacts

Skill174 starsChanged 2 months agoMITView on GitHub

Generate the comprehensive demo markdown artifacts from the current codebase. Use before UAT to ensure test artifacts reflect the latest code.

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 4 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use the stable wrapper script: scripts/generate-demo-artifacts.sh

    line 17
  2. Distinctive:

    Run individual dotnet commands instead of the wrapper script

    line 24
  3. Distinctive:

    Before running UAT (to ensure artifacts match current code)

    line 73
  4. Distinctive:

    After making changes to templates or rendering logic

    line 74
  5. Very specific:

    After updating the comprehensive demo plan.json

    line 75
  6. Distinctive:

    When setting up a new development environment

    line 76

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Generate Demo Artifacts

Purpose

Regenerate all demo markdown artifacts using the current code. This ensures UAT tests validate the actual behavior of the tool, not stale output.

Hard Rules

Must

  • Use the stable wrapper script: scripts/generate-demo-artifacts.sh
  • Script will handle building, generating artifacts, and verification automatically
  • Always allow this script — it only reads input files and writes artifacts, no dangerous operations

Must Not

  • Modify the input plan.json or demo-principals.json files
  • Run individual dotnet commands instead of the wrapper script
  • Skip verification of generated output

Actions

Generate All Demo Artifacts

scripts/generate-demo-artifacts.sh

This single command:

  1. Builds the project in Release configuration
  2. Generates all artifacts in /artifacts/ (used for UAT):
    • comprehensive-demo.md (inline-diff format, for Azure DevOps UAT)
    • comprehensive-demo-simple-diff.md (simple diff format, for GitHub UAT)
    • role.md (role assignments with principal mapping)
    • role-default.md (role assignments without principal mapping)
  3. Generates all documentation samples in examples/comprehensive-demo/:
    • report.md (default template)
    • report-with-sensitive.md (with --show-sensitive)
    • report-summary.md (summary template)
  4. Verifies all outputs are valid markdown
  5. Reports success or failure with clear error messages

Expected Output

[INFO] Building project (Release configuration)...
[INFO] Generating artifacts/comprehensive-demo.md (inline-diff, for Azure DevOps UAT)...
[INFO] ✓ artifacts/comprehensive-demo.md generated successfully (inline-diff)
[INFO] Generating artifacts/comprehensive-demo-simple-diff.md (for GitHub UAT)...
[INFO] ✓ artifacts/comprehensive-demo-simple-diff.md generated successfully
[INFO] Generating artifacts/role.md (role assignments with principal mapping)...
[INFO] ✓ artifacts/role.md generated successfully
[INFO] Generating artifacts/role-default.md (role assignments without principal mapping)...
[INFO] ✓ artifacts/role-default.md generated successfully
[INFO] Generating examples/comprehensive-demo/report.md (default template)...
[INFO] ✓ examples/comprehensive-demo/report.md generated successfully
[INFO] Generating examples/comprehensive-demo/report-with-sensitive.md (with --show-sensitive)...
[INFO] ✓ examples/comprehensive-demo/report-with-sensitive.md generated successfully
[INFO] Generating examples/comprehensive-demo/report-summary.md (summary template)...
[INFO] ✓ examples/comprehensive-demo/report-summary.md generated successfully
[INFO] All demo artifacts generated successfully

When to Use

  • Before running UAT (to ensure artifacts match current code)
  • After making changes to templates or rendering logic
  • After updating the comprehensive demo plan.json
  • When setting up a new development environment

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free