Add documentation for exposed types
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- typescript
調査の方向性
まず TypeScript のエクスポートされた型とインターフェースを確認し、次に issue で言及されているドキュメント生成の選択肢を比較します: TypeDoc、typegen、api-extractor。完了条件は、公開される型についてユーザー向けドキュメントが生成され、選択したアプローチがプロジェクトに統合されていることです。
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
There is absolutely no user-facing documentation for any of the exposed types/interfaces.
Describe the solution you'd like
Autogeneration of documentation from the exported types would be nice.
Describe alternatives you've considered
A simple web search turns up a few options, such as this or this. Additionally, api-extractor, which I've looked into using for other reasons, can do this as well.
- 主要言語
- TypeScript
- スター
- 440
- フォーク
- 61
- 平均マージ
- 19時間 52分
- マージ済み PR（30日）
- 23
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
StackExchange/Stacks-Editor のほかの issue
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
StackExchange/Stacks-Editor#504 · コメント 1 件 · リアクション 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
StackExchange/Stacks-Editor#395 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
StackExchange/Stacks-Editor#343 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Task list supportオープンenhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
StackExchange/Stacks-Editor#272 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
StackExchange/Stacks-Editor#250 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
StackExchange/Stacks-Editor の issue をすべて見る
似ている issue
-
Bayern feature:Application ready web
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
digitalfabrik/entitlementcard#3176 ·
メンテナーはふだん 7 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
NanmiCoder/cc-haha#1533 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
🐛 Bug: Calendar work items cannot be opened on mobile対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100