Author the docs plugin's own documentation (dogfood)
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 48/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- markdown, typescript
調査の方向性
Read the docs plugin implementation and its Velite pipeline, then follow the repository's docs conventions and GLOSSARY.md. Author the plugin guide in the docs tree with the requested frontmatter fields, covering the plugin, build process, adding docs, and OpenAPI/MCP access. Verify the page renders on /docs; completion also depends on blocked issue #447.
索引モデルが issue の本文から書いたものです。
説明
Parent
#444
What to build
The docs plugin documents itself, through its own pipeline: author its user- and agent-facing documentation as markdown in the repository's docs tree, then verify it renders on /docs via the plugin's velite pipeline. This is the first real content authored against the new system and the proof the pipeline works for humans writing docs, not just compiling existing ones.
Content to cover: what the plugin is and why (docs-as-code over the repo's existing markdown culture), how content is compiled at build time, the frontmatter schema (title, description, tags, order), how to add a doc, and how agents read the docs via OpenAPI/MCP.
Blocked by: #447
Acceptance criteria
- The plugin's documentation page renders on
/docsthrough the plugin's own pipeline - Content follows repo docs conventions (kebab-case naming, GLOSSARY.md vocabulary)
- Frontmatter demonstrates the full schema (tags, order) so the index view is exercised
- 主要言語
- TypeScript
- スター
- 5
- フォーク
- 3
- 平均マージ
- 12時間 36分
- マージ済み PR（30日）
- 79
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NEARBuilders/everything-dev のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
NEARBuilders/everything-dev#400 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
NEARBuilders/everything-dev#485 ·
メンテナーはふだん 1 日以内に返信
-
ready-for-agent
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
NEARBuilders/everything-dev#484 ·
メンテナーはふだん 1 日以内に返信
-
ready-for-agent
難易度 4/5 3〜5日 初心者へのやさしさ 53/100
NEARBuilders/everything-dev#483 ·
メンテナーはふだん 1 日以内に返信
-
ready-for-agent
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
NEARBuilders/everything-dev#482 ·
メンテナーはふだん 1 日以内に返信
NEARBuilders/everything-dev の issue をすべて見る
似ている issue
-
area:workflow bug ready-for-human
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
fil-donadoni/tolaria#6108 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
apache/rocketmq-dashboard#7234 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
vitest-dev/vitest#11656 ·
メンテナーはふだん 1 日以内に返信
-
e2e-failure ready-to-code
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
redhat-developer/rhdh-plugin-export-overlays#4460 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
ehmpathy/rhachet-roles-bhrain#655 ·
メンテナーはふだん 1 日以内に返信