Conversation
grafana-catalog-project-bot
Bot
moved this from 📬 Triage
to 🧑💻 In development
in Grafana Catalog Team
Base automatically changed from
eriksundell/plugin-docs-cli-meta-files
to
main
August 20, 2026 10:09
sunker
force-pushed
the
eriksundell/panel-docs-codemod
branch
from
August 20, 2026 10:31
b985289 to
bdd44bc
Compare
@grafana/create-plugin
@grafana/eslint-config
@grafana/eslint-plugin-plugins
@grafana/plugin-docs-cli
@grafana/plugin-docs-parser
@grafana/plugin-e2e
@grafana/plugin-meta-extractor
@grafana/plugin-types-bundler
@grafana/react-detect
@grafana/sign-plugin
@grafana/tsconfig
commit: |
sunker
force-pushed
the
eriksundell/panel-docs-codemod
branch
2 times, most recently
from
September 9, 2026 12:05
f100720 to
e4d428c
Compare
… in panel-docs README template
…odemod 0.2.1 is now published and includes the repo-meta-file exclusion and inline-code-masking fixes that 0.2.0 predates.
index.md scaffolded an Overview page with Introduction/Features/Requirements, duplicating what the plugin's real README already covers on the Overview tab. It's now a curated router for the Documentation tab instead: orientation, recommended reading path, task-oriented links. Also makes clear Installation and Changelog are catalog-generated, not authored under docs/.
sunker
force-pushed
the
eriksundell/panel-docs-codemod
branch
from
September 9, 2026 12:17
e4d428c to
4610f1d
Compare
sunker
changed the title
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
1 participant
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.
What this PR does / why we need it:
Adds
create-plugin add docs, which scaffolds multi-page documentation for a plugin and wires it up for publishing.It reads the plugin type from
plugin.jsonand copies the matching templates fromtemplates/docs/<type>/plus the sharedtemplates/docs/common/. Onlypanelis supported so far -appanddatasourceget a clear "not supported yet" error rather than a broken scaffold.What lands in the plugin:
docs/, each section carrying a note saying what belongs there, plus a README explaining the four catalog tabs and what sources eachdocsPathinplugin.json,docs:serveanddocs:validatescripts, avalidate-docs.ymlworkflow and abuild-pluginversion bump.config/AGENTS/plugin-docs.mdand abootstrap-plugin-docsskill written to.claude/,.agents/and.codex/A freshly scaffolded folder validates clean. Unfilled stubs are reported as notes rather than errors, so CI is green from the first commit while still checking links, frontmatter and images. They do block publishing, which matters because the
<!-- section-brief -->marker is stripped when the page renders but the "📝 Fill this in" text is not - a forgotten stub would ship to the catalog verbatim.Re-running is additive: existing files are never overwritten, so a plugin can pick up updated agent files after a
create-pluginbump.Which issue(s) this PR fixes:
N/A
Special notes for your reviewer:
The
docs:validatescript passes--allow-unfilled-stubs, added in #2864. Older CLIs ignore the unknown flag and report stubs as errors, so nothing breaks before it releases - but the@grafana/plugin-docs-clipin needs bumping once it does.Supersedes #2843, now closed. AI assistance is part of this PR rather than a separate opt-in layer.