Generated package docs are missing most of the info
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- typescript
調査の方向性
Start by reproducing the missing documentation on the linked npmx.dev page for effect-web-midi and inspect its package.json exports map, especially the wildcard entrypoints. Then trace how the docs generator discovers exported symbols and their attached documentation. Done means the generated package docs include the documented exported functions across the package's entrypoints.
索引モデルが issue の本文から書いたものです。
説明
Describe the bug
https://npmx.dev/package/effect-web-midi/
Docs generator doesn't look very deep to find the actual info about the exported symbols from the package. Due to the specific package organizational structure, many exported functions are not rendered, even though they have actual documentation attached.
https://npmx.dev/package-code/effect-web-midi/v/0.2.1/src%2Finternal%2FEMIDIAccess.ts
And it has more than one entrypoint (especially the ones with wildcards)
{
"exports": {
".": {
"types": "./dist-types/index.d.ts",
"default": "./dist/index.js"
},
"./*.js": {
"types": "./dist-types/src/*.d.ts",
"default": "./dist/src/*.js"
},
"./*.ts": "./src/*.ts",
"./*": {
"types": "./dist-types/src/*.d.ts",
"default": "./dist/src/*.js"
},
"./internal/*": null,
"./package.json": "./package.json"
}
}
- 主要言語
- TypeScript
- スター
- 3.6k
- フォーク
- 533
- 平均マージ
- 4日 1時間
- マージ済み PR（30日）
- 39
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
npmx-dev/npmx.dev のほかの issue
-
feat: add option to reset all settings to defaults対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンpending triage
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
a11y front
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
npmx-dev/npmx.dev#2914 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
front i18n
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
npmx-dev/npmx.dev#2831 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
back stale stale-to-close
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
npmx-dev/npmx.dev#2511 · コメント 4 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
npmx-dev/npmx.dev の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
awesome-dsh-plugin/awesome-dsh-plugin#9184 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
farion1231/cc-switch#8829 ·
メンテナーはふだん 1 日以内に返信
-
[core-client] Remove unused hand-maintained transport helpers after the definition-table cutoverオープンdoc-audit enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100