Rethink Plugin API documentation: auto-generate JSON API spec, generate `.pyi` and `.d.ts` from there
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 15/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 活発
- 技術スタック
- json, python, typescript
- 領域
- api, documentation
調査の方向性
The payload names no files or entry points; it covers the RPC protocol as documented in the executable, Python and Node plugin guides of the Flow-Launcher docs repo. Start by reading those guides to see what protocol detail they repeat. Done would mean a decision on the spec format and tooling, agreed in the thread, before any generator for .pyi or .d.ts is written.
索引モデルが issue の本文から書いたものです。
説明
Extracted from: https://github.com/Flow-Launcher/docs/pull/108#discussion_r4232118122
Documenting the RPC protocol in the various language-specific plugin guides is not ideal. Rather, we should decide on a formal, generated reference for the RPC spec, the same way you might see documentation for a C# API, or a .d.ts reference. Then these various non-C# plugin guides - executable, python, node - can stop documenting the protocol and instead reference the formal spec.
This spec can also be used to generate types for the TypeScript/JavaScript and Python libraries which make plugin development easier. Someone should be able to easily import the library in their node or python project and get rich intellisense for JSON requests and responses.
- 主要言語
- Svelte
- スター
- 23
- フォーク
- 23
- 平均マージ
- 9日 34分
- マージ済み PR（30日）
- 3
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Flow-Launcher/docs のほかの issue
-
documentation
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
Flow-Launcher/docs#99 ·
-
bug
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
Flow-Launcher/docs#87 · コメント 13 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 45/100
Flow-Launcher/docs#79 · コメント 2 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
Flow-Launcher/docs#49 · コメント 1 件 ·
-
Deploy on Vercelオープン
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
Flow-Launcher/docs#4 · コメント 12 件 ·
Flow-Launcher/docs の issue をすべて見る
似ている issue
-
nextjs-tracking
難易度 2/5 1〜3時間 初心者へのやさしさ 69/100
cloudflare/vinext#3920 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
glpi-project/glpi#25922 ·
メンテナーはふだん 1 日以内に返信
-
unbounded value for n in `/v1/logs` can panic/OOM対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンsmall item
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
canonical/pebble#1127 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
beginner friendly community contributions-welcome good first issue hacktoberfest health help wanted up-for-grabs
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
StackExchange/StackExchange.Redis#3274 ·
メンテナーはふだん 1 日以内に返信