Skip to content

Document local skill generation in README #33

@scotthavird

Description

@scotthavird

Problem

The CLI README has no mention of `promptconduit skills generate --local`, the zero-account skill extraction feature shipped in #31. Developers who find the repo via GitHub or the homepage have no documentation on how to use the local path, what AI providers are supported, or which transcript sources are read. The Supported Tools table also lists only the three real-time hook tools (Claude Code, Cursor, Gemini CLI) and omits the two tools added for local mode (Codex CLI, GitHub Copilot).

Solution

Add comprehensive documentation for the `--local` flag: a "No platform account?" callout in Quick Start, `skills generate` in the Commands overview, and a full "Local Skill Generation" section with all flags, AI provider priority order, how-it-works explanation, and example terminal output. Also split the Supported Tools table into "real-time hooks" and "local skill detection" paths.

Architecture

```mermaid
flowchart LR
A[Developer reads README] --> B{Has platform account?}
B -- Yes --> C[Quick Start → install + hook]
B -- No --> D[callout → Local Skill Generation section]
D --> E[promptconduit skills generate --local]
E --> F[auto-detect: claude CLI / API key]
F --> G[SKILL.md written to ~/.claude/skills/]
```

Business Impact

  • Open-source developers can self-serve the local path without needing docs elsewhere
  • Accurate tool table surfaces Codex and Copilot support

Acceptance Criteria

  • Supported Tools table split into hooks vs local detection
  • Quick Start has "No platform account?" callout
  • `skills generate --local` in Commands overview
  • Local Skill Generation section with flags, provider priority, how-it-works, example output

Technical Notes

  • Files affected: `README.md`
  • Dependencies: none
  • Breaking changes: none

Agent Context

  • change-type: docs
  • risk-level: low
  • test-coverage: markdown rendering review
  • rollback-plan: revert README.md

Workflow Progress

```mermaid
graph LR
A[Analyze] --> B[Issue] --> C[Branch] --> D[Implement] --> E[PR] --> F[Review] --> G[CI] --> H[Merge] --> I[Deploy] --> J[Shipped]
classDef done fill:#22c55e,stroke:#16a34a,color:#fff
classDef active fill:#eab308,stroke:#ca8a04,color:#fff
classDef todo fill:#d1d5db,stroke:#9ca3af,color:#fff
class A,B,C,D,E,F,G,H,I,J done
```

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions