Skip to content

I19.7 · Short README, "which kind fits my source?" guide, new-plugin asks for a kind #178

Open

Description

@adssib

Part of #171

Story

As a new contributor, I want a README I can read in one screen and a guide that tells me which kind my source is, so I can start in minutes.

Subtasks

  • README: what it is in two lines, three steps to start, links. No plugin table, no count, no coverage claims; one line that the list is served at GET /v1/plugins
  • Details move to docs/
  • docs/which-kind.md: questions ("an OpenAPI spec?", "a changelog?", "a guide per major?", "a page of dates?", "a feed?", "a flat catalog?", "a published package?") → the kind
  • go run ./cmd/new-plugin --provider <id> --source <id> --kind <kind> (--format kept as an alias for one release)

Acceptance criteria

  • The README fits one screen
  • Every registered source fits one answer of the guide
  • new-plugin's own test scaffolds one source per kind and builds, vets and tests it

Activity

  1. changed the title [-]I19.7 · "Which kind fits my provider?" guide; new-plugin asks for a kind[/-] [+]I19.7 · Short README, "which kind fits my source?" guide, new-plugin asks for a kind[/+] on Nov 20, 2026
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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions