Skip to content

Create a polished examples/template pack for common use cases #154

Closed

Description

@httpdss

Summary

Add a high-quality examples pack that demonstrates StructKit’s strongest use cases and gives visitors ready-made templates to try.

Proposed examples

  • Python CLI project scaffold.
  • FastAPI service scaffold.
  • Terraform module scaffold.
  • GitHub Actions CI baseline scaffold.
  • MCP/AI-agent-friendly project scaffold.

Why this matters

Examples are the fastest path from GitHub visit to successful first use. They also provide source material for docs, blog posts, Shorts, and community posts.

Scope

  • Add or improve example YAML structures under the repo’s existing examples/contrib structure.
  • Add a short README for each example with use case, command, expected output, and customization notes.
  • Add a top-level examples index that explains which template to try first.
  • Verify every example works with current StructKit commands.

Acceptance criteria

  • At least 5 polished examples exist and are documented.
  • Each example has a copy-paste command and expected output description.
  • Examples are included in tests or a lightweight verification script where practical.
  • The main README links to the examples index.

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions