Docs plugin: velite content pipeline + read-only API
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- typescript
- 領域
- api, backend, documentation
調査の方向性
Start with the plugin template and the repository's beforeCompile escape hatch described in the issue, then read the authored config and existing oRPC handler conventions. Implementing this spans content compilation, API routes, plugin registration, and deploy behavior; the issue says it is blocked by #445. Done means the listed build, API, OpenAPI/MCP, and no-DB/no-secrets acceptance criteria pass.
索引モデルが issue の本文から書いたものです。
説明
Parent
#444
What to build
The docs plugin end to end on the read path: scaffolded from the template, a Velite content pipeline that compiles the repository's docs at build time, and a read-only oRPC router serving the compiled content. Users (and agents, via OpenAPI/MCP) can list and read the repo's documentation through the API.
velite.config.tscompilesdocs/**andGLOSSARY.md(markdown format, raw body kept for client render; zod frontmatter: title, description, tags, order) — velite runs from a rspackbeforeCompilehook appended via the ticket #1 escape hatch, so no hand-run velite step in dev or buildlistPublished(paginated, tag/search filter) andgetBySlugoRPC routes serve the compiled JSON; compiled content imports into the plugin source so the bundle is self-contained- Registered in the authored config with a UI mount; no database, no secrets
- Handlers follow the repo convention:
.effect()generators, services viayield* Tag, typed error shapes
Blocked by: #445
Acceptance criteria
-
every-plugin build(and the deploy train) compiles content with no manual velite invocation; the velite output directory is gitignored -
GET /api/rpc/docs/listPublishedreturns the repository's docs with pagination metadata -
GET /api/rpc/docs/getBySlugreturns a real ADR or glossary entry's raw markdown + metadata - The docs routes appear in the OpenAPI spec and MCP tools
- Plugin definition carries no DB layer and no secrets
- 主要言語
- TypeScript
- スター
- 5
- フォーク
- 3
- 平均マージ
- 10時間 12分
- マージ済み PR（30日）
- 102
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NEARBuilders/everything-dev のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
NEARBuilders/everything-dev#400 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
NEARBuilders/everything-dev#531 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
NEARBuilders/everything-dev#526 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 42/100
NEARBuilders/everything-dev#518 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bug needs-triage
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
NEARBuilders/everything-dev#496 ·
メンテナーはふだん 1 日以内に返信
NEARBuilders/everything-dev の issue をすべて見る
似ている issue
-
Add: Pbs Kidsオープンcheck:passed streams:add
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
メンテナーはふだん 2 日以内に返信
-
maintanance
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
inmanta/web-console#7583 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
deltachat/deltachat-desktop#6881 · コメント 1 件 ·
メンテナーはふだん 3 日以内に返信
-
[Bug Report][3.13.7] VDataTable with select-strategy="single" shows select-all checkbox in mobile mode対応中かも @lazerg が今日担当しました。 オープンS: triage
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
phivk/rubiks-lab#33 ·
メンテナーはふだん 1 日以内に返信