Repository navigation
Conversation
The README says what the repo is in two lines, adds a provider in three steps and links docs/. How a plugin works, the layout, the checks and releases move to docs/how-it-works.md. writing-a-plugin.md covers providers, sources, kinds and layers, registering with RegisterProvider, and reading a source version by version (ListVersions, ReadAt, Extract, core/versions). The README template is one screen too, and never lists what's covered. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: adssib <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #209. Refs #178 (I19.7, the "which kind" part of writing-a-plugin.md) and #171.
What this changes
Docs only.
docs/, CONTRIBUTING, AGENTS, Discussions and the docs site. No coverage table, no provider names list, no layer statuses.docs/how-it-works.md(new): providers, sources, kinds and layers; what a plugin does, version by version; the layout; the checks; releases (with theplugins.jsonasset). This is what used to be in the README's lower half, updated.docs/writing-a-plugin.md: providers, sources (provider/source), kinds ("Pick the kind", with the no-Kubernetes-kind rule), layers; registering withplugin.RegisterProvider; a new section "Every version, not only the newest" (ListVersions,ReadAt,Extract,core/versions, never pin a tag in code: pin a case in the test);core/githubfor GitHub lookups.docs/README-template.md: the README shape every public repo follows is now one screen (what, badges, three-step quickstart, links) and never lists what's covered (the old "What it covers" table with Noticed/Fixed statuses is gone from the template).Checklist
testdata/README.md, drop tests, provider pages: not applicablemake checkpasses locallyCalls I made (please check)
Related PRs
plugins.jsonrelease asset)apps/plugins-repo.md)🤖 Generated with Claude Code