aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-08-03 05:20:15 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-08-04 03:58:21 +0300
commitb12da23918ff94099e7fcedd7db79f3d2fa8fa6f (patch)
treef58d7e0c1058414c7292d56257aace56eb4e079a /docs
parente7c96206f716e5772971af2861c04168af2bb396 (diff)
feat(plugins): index marketplace manifests
Diffstat (limited to 'docs')
-rw-r--r--docs/next/CHANGELOG.md3
-rw-r--r--docs/next/website/src/content/docs/ja/marketplace.mdx33
-rw-r--r--docs/next/website/src/content/docs/ja/plugins.mdx11
-rw-r--r--docs/next/website/src/content/docs/marketplace.mdx35
-rw-r--r--docs/next/website/src/content/docs/plugins.mdx15
-rw-r--r--docs/next/website/src/content/docs/zh-cn/marketplace.mdx24
-rw-r--r--docs/next/website/src/content/docs/zh-cn/plugins.mdx12
7 files changed, 72 insertions, 61 deletions
diff --git a/docs/next/CHANGELOG.md b/docs/next/CHANGELOG.md
index da9c9b71..7d1b9620 100644
--- a/docs/next/CHANGELOG.md
+++ b/docs/next/CHANGELOG.md
@@ -2,6 +2,9 @@
## Unreleased
+### Added
+- The plugin marketplace now discovers valid manifests at repository roots and subdirectories, groups multiple plugins under each repository, and publishes their versions and exact default-branch commits.
+
## [0.8.0] - 2026-08-03
### Added
diff --git a/docs/next/website/src/content/docs/ja/marketplace.mdx b/docs/next/website/src/content/docs/ja/marketplace.mdx
index 5f0a5c4c..5afb0675 100644
--- a/docs/next/website/src/content/docs/ja/marketplace.mdx
+++ b/docs/next/website/src/content/docs/ja/marketplace.mdx
@@ -9,10 +9,11 @@ Herdr プラグインマーケットプレイスは、コミュニティ製プãƒ
## プラグインを探す
-[マーケットプレイス](/plugins/)には、GitHub トピック `herdr-plugin` が付いた
-すべての公開リポジトリが掲載されます。名前、オーナー、説明、言語で検索でき、
-人気順、最近の活動順、新着順で並べ替えられます。各掲載はソースリポジトリの
-GitHub ページに直接リンクしています。
+[マーケットプレイス](/plugins/)には、GitHub トピック `herdr-plugin` が付いており、
+デフォルトブランチに必須メタデータを解析できる `herdr-plugin.toml` が 1 つ以上ある
+公開リポジトリが掲載されます。リポジトリとプラグインのメタデータを検索でき、
+リポジトリカードを人気順、最近の活動順、新着順で並べ替えられます。各カードは
+ソースリポジトリにリンクし、その中で検出されたすべてのプラグインを表示します。
掲載は自動かつ無審査です。掲載されているのはリポジトリが自らトピックを
付けたからであって、Herdr が検証したからではありません。インストールする前に
@@ -35,19 +36,17 @@ herdr plugin install owner/repo[/subdir...]
## 自分のプラグインを掲載する
-公開リポジトリに GitHub トピック `herdr-plugin` を追加してください。
-インデックスが使うシグナルはこのトピックだけなので、公開プラグインに
-トピックを付けるだけで掲載されます。インデックスは 30 分ごとに自動更新される
-ため、新しくトピックを付けたリポジトリはまもなく表示され、トピックを外した
-リポジトリは次回の更新で消えます。
+公開リポジトリに GitHub トピック `herdr-plugin` を追加し、デフォルトブランチに
+必須メタデータを解析できる `herdr-plugin.toml` を 1 つ以上置いてください。
+マニフェストはルートにもサブディレクトリにも配置できます。マーケットプレイスは
+1 リポジトリにつき 1 枚のカードを使い、有効な各マニフェストを個別にインストール
+できるプラグインとして表示します。インデックスは 30 分ごとに自動更新されます。
## 掲載に表示される内容
-各カードには GitHub リポジトリのメタデータが表示されます: リポジトリ名と
-オーナー、説明、スター数、主要言語、最終 push 時刻、そしてソースへのリンクです。
-インデックスは GitHub のリポジトリ検索からこれらを読み取るため、リポジトリの
-説明とトピックを正確に保つことが、掲載を有用にする鍵になります。
-
-インデックスはまだ `herdr-plugin.toml` を解析しないため、プラグインの `id`、
-宣言された `platforms`、`min_herdr_version` といったマニフェストのフィールドは
-v1 では表示されません。フォークとアーカイブ済みリポジトリは一覧から除外されます。
+各カードには GitHub リポジトリの名前、オーナー、説明、スター数、主要言語、
+最終 push 時刻が表示されます。プラグイン行には各マニフェストの `name` と `version`
+が表示され、正確なソースディレクトリにリンクします。インデックスにはパス、`id`、
+`name`、`version`、`platforms`、`min_herdr_version` と、デフォルトブランチの正確な
+コミットが記録されます。フォーク、アーカイブ済みリポジトリ、有効なプラグイン
+マニフェストがないリポジトリ、不正なメタデータは一覧から除外されます。
diff --git a/docs/next/website/src/content/docs/ja/plugins.mdx b/docs/next/website/src/content/docs/ja/plugins.mdx
index db5342cd..aae2ad41 100644
--- a/docs/next/website/src/content/docs/ja/plugins.mdx
+++ b/docs/next/website/src/content/docs/ja/plugins.mdx
@@ -358,10 +358,13 @@ v1 には Herdr が管理するプラグインストレージ API はありまã�
## マーケットプレイス
コミュニティ製プラグインは[マーケットプレイス](/plugins/)で探せます。これは
-GitHub トピック `herdr-plugin` が付いた公開 GitHub リポジトリの自動インデックスです。
-プラグインは普通の GitHub リポジトリのままです: `herdr-plugin.toml` を含めて公開し、
+GitHub トピック `herdr-plugin` が付いており、必須メタデータを解析できる
+`herdr-plugin.toml` が 1 つ以上ある公開 GitHub リポジトリの自動インデックスです。
+プラグインは普通の GitHub リポジトリのままです: 公開して
`herdr plugin install owner/repo[/subdir]` を共有してください。
-プラグインを掲載するには、公開リポジトリに GitHub トピック `herdr-plugin` を
-追加します。インデックスは 30 分ごとに更新されます。発見の仕組みは
+プラグインを掲載するには、公開リポジトリに GitHub トピック `herdr-plugin` を追加し、
+デフォルトブランチのルートまたはサブディレクトリにマニフェストを置きます。
+1 つのリポジトリカードに複数のプラグインを掲載できます。インデックスは 30 分ごとに
+更新されます。発見の仕組みは
[マーケットプレイス](/ja/docs/marketplace/)を参照してください。
diff --git a/docs/next/website/src/content/docs/marketplace.mdx b/docs/next/website/src/content/docs/marketplace.mdx
index 09a27b2d..88bbaf98 100644
--- a/docs/next/website/src/content/docs/marketplace.mdx
+++ b/docs/next/website/src/content/docs/marketplace.mdx
@@ -9,10 +9,12 @@ GitHub repositories, not a reviewed catalog.
## Browse plugins
-The [marketplace](/plugins/) lists every public repository tagged with the
-GitHub topic `herdr-plugin`. Search by name, owner, description, or language,
-and sort by popularity, recent activity, or newest. Each listing links straight
-to its source repository on GitHub.
+The [marketplace](/plugins/) lists public repositories tagged with the GitHub
+topic `herdr-plugin` when their default branch contains at least one
+`herdr-plugin.toml` whose required metadata can be parsed. Search by repository
+or plugin metadata, and sort repository cards by popularity, recent activity,
+or newest. Each card links to its source repository and lists every discovered
+plugin inside it.
Discovery is automatic and unreviewed. A listing means a repository tagged
itself, not that Herdr vetted it, so the
@@ -34,20 +36,19 @@ its root, or in a subdirectory, and that command works. See
## Get your plugin listed
-Add the GitHub topic `herdr-plugin` to a public repository. That topic is the
-only signal the index uses, so tagging a public plugin is all it takes. The
-index refreshes automatically every 30 minutes, so a newly tagged repository
-shows up shortly after, and one that drops the topic disappears on the next
-refresh.
+Add the GitHub topic `herdr-plugin` to a public repository and put one or more
+`herdr-plugin.toml` manifests with parseable required metadata on its default
+branch. Manifests may be at the root or in subdirectories. The marketplace uses
+one card per repository and lists each valid manifest as a separately
+installable plugin. The index refreshes automatically every 30 minutes and
+rescans repositories when their default-branch head changes.
## What a listing shows
Each card shows GitHub repository metadata: the repository name and owner, its
-description, star count, primary language, and the time it was last pushed, with
-a link back to the source. The index reads this from GitHub's repository search,
-so keeping your repository description and topics accurate is what makes your
-listing useful.
-
-The index does not parse `herdr-plugin.toml` yet, so manifest fields like the
-plugin `id`, declared `platforms`, and `min_herdr_version` are not shown in v1.
-Forks and archived repositories are excluded from the list.
+description, star count, primary language, and the time it was last pushed. Its
+plugin rows show each manifest's `name` and `version` and link to the exact
+source directory. The index records the manifest path, `id`, `name`, `version`,
+`platforms`, and `min_herdr_version` together with the exact default-branch
+commit. Forks, archived repositories, repositories without a valid plugin
+manifest, and malformed manifest metadata are excluded.
diff --git a/docs/next/website/src/content/docs/plugins.mdx b/docs/next/website/src/content/docs/plugins.mdx
index 1d93bedc..418d5af6 100644
--- a/docs/next/website/src/content/docs/plugins.mdx
+++ b/docs/next/website/src/content/docs/plugins.mdx
@@ -363,10 +363,13 @@ state should own their files or database.
## Marketplace
Community plugins are discoverable in the [marketplace](/plugins/), an automatic
-index of public GitHub repositories tagged with the topic `herdr-plugin`.
-Plugins stay ordinary GitHub repositories: publish one with `herdr-plugin.toml`,
-then share `herdr plugin install owner/repo[/subdir]`.
-
-To get a plugin listed, add the GitHub topic `herdr-plugin` to its public
-repository. The index refreshes every 30 minutes. See
+index of public GitHub repositories tagged with `herdr-plugin` that contain one
+or more `herdr-plugin.toml` files whose required metadata can be parsed. Plugins
+stay ordinary GitHub repositories: publish one, then share
+`herdr plugin install owner/repo[/subdir]`.
+
+To get plugins listed, add the GitHub topic `herdr-plugin` and place their
+manifests at the root or in subdirectories of the repository's default branch.
+One repository card can contain multiple separately installable plugins. The
+index refreshes every 30 minutes. See
[Marketplace](/docs/marketplace/) for how discovery works.
diff --git a/docs/next/website/src/content/docs/zh-cn/marketplace.mdx b/docs/next/website/src/content/docs/zh-cn/marketplace.mdx
index 350cc0d5..246048c7 100644
--- a/docs/next/website/src/content/docs/zh-cn/marketplace.mdx
+++ b/docs/next/website/src/content/docs/zh-cn/marketplace.mdx
@@ -9,9 +9,10 @@ Herdr 插件市场是一个可供发现的社区插件索引。
## 浏览插件
-[插件市场](/plugins/)会列出所有打了 GitHub 主题标签 `herdr-plugin` 的公开仓库。
-你可以按名称、作者、描述或语言搜索,并按热度、最近活跃度或最新排序。
-每个条目都直接链接到它在 GitHub 上的源码仓库。
+[插件市场](/plugins/)会列出带有 GitHub 主题标签 `herdr-plugin`,并且默认分支中
+至少包含一个必需元数据可解析的 `herdr-plugin.toml` 的公开仓库。你可以搜索仓库和
+插件元数据,并按热度、最近活跃度或最新排序仓库卡片。每张卡片链接到源码仓库,
+并列出其中发现的所有插件。
收录是自动且未经审核的。被列出只说明仓库给自己打了标签,并不代表 Herdr
审查过它,所以在安装任何插件之前,请先阅读[信任指南](/zh-cn/docs/plugins/#信任与安全)。
@@ -30,15 +31,14 @@ herdr plugin install owner/repo[/subdir...]
## 让你的插件被收录
-给公开仓库添加 GitHub 主题标签 `herdr-plugin`。索引只使用这一个信号,
-所以给公开插件打上标签就够了。索引每 30 分钟自动刷新,新打标签的仓库很快
-就会出现,去掉标签的仓库会在下一次刷新时消失。
+给公开仓库添加 GitHub 主题标签 `herdr-plugin`,并在默认分支中放置一个或多个
+必需元数据可解析的 `herdr-plugin.toml`。清单可以位于根目录或子目录。插件市场
+每个仓库显示一张卡片,并把每份有效清单列为可单独安装的插件。索引每 30 分钟
+自动刷新。
## 条目会展示什么
-每张卡片展示 GitHub 仓库的元数据: 仓库名和作者、描述、star 数、主要语言、
-最后 push 时间,以及指回源码的链接。索引从 GitHub 的仓库搜索读取这些信息,
-所以保持仓库描述和主题标签的准确,是让条目有用的关键。
-
-索引目前还不会解析 `herdr-plugin.toml`,所以插件 `id`、声明的 `platforms`、
-`min_herdr_version` 等清单字段在 v1 中不会展示。Fork 和已归档的仓库会被排除。
+每张卡片展示 GitHub 仓库的名称、作者、描述、star 数、主要语言和最后 push 时间。
+插件行展示每份清单的 `name` 和 `version`,并链接到精确的源码目录。索引还会记录
+清单路径、`id`、`name`、`version`、`platforms`、`min_herdr_version`,以及默认分支的
+精确提交。Fork、已归档仓库、没有有效插件清单的仓库以及无效清单元数据都会被排除。
diff --git a/docs/next/website/src/content/docs/zh-cn/plugins.mdx b/docs/next/website/src/content/docs/zh-cn/plugins.mdx
index 306bda53..67c606f0 100644
--- a/docs/next/website/src/content/docs/zh-cn/plugins.mdx
+++ b/docs/next/website/src/content/docs/zh-cn/plugins.mdx
@@ -319,10 +319,12 @@ v1 没有 Herdr 管理的插件存储 API。需要持久状态的插件应自己
## 插件市场
-社区插件可以在[插件市场](/plugins/)中发现,它是打了 `herdr-plugin` 主题
-标签的公开 GitHub 仓库的自动索引。插件仍然是普通的 GitHub 仓库: 发布一个
-带 `herdr-plugin.toml` 的仓库,然后分享
+社区插件可以在[插件市场](/plugins/)中发现,它是打了 `herdr-plugin` 主题标签且
+包含一个或多个必需元数据可解析的 `herdr-plugin.toml` 的公开 GitHub 仓库自动索引。
+插件仍然是普通的 GitHub 仓库: 发布后分享
`herdr plugin install owner/repo[/subdir]`。
-要让插件被收录,给它的公开仓库添加 GitHub 主题标签 `herdr-plugin`。索引
-每 30 分钟刷新一次。发现机制的工作方式见[插件市场](/zh-cn/docs/marketplace/)。
+要让插件被收录,给公开仓库添加 GitHub 主题标签 `herdr-plugin`,并在默认分支的
+根目录或子目录放置清单。一张仓库卡片可以包含多个插件。索引每 30 分钟刷新一次。
+发现机制的工作方式见
+[插件市场](/zh-cn/docs/marketplace/)。