docs: fix the TypeDoc warnings and hide the protected internals of NetworkServerLibrary
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- typescript
調査の方向性
Start by reading typedoc.json and the TypeDoc output from pnpm run docs; the issue names affected APIs across core, ecs, network server, and scene, plus server.network.base.ts. Review the unresolved links and unexported referenced types, then check how protected members are documented. Done when the command reports no warnings and the generated NetworkServerLibrary reference hides the listed protected internals.
索引モデルが issue の本文から書いたものです。
説明
What is the type of issue?
Documentation is incorrect, Documentation is missing
What is the issue?
pnpm run docs (TypeDoc, branch feat/docs-navigation) ends with 0 errors and 14 warnings, and publishes some implementation details:
NetworkServerLibrarydocuments its protected fields_registry,_serverand_trace(https://github.com/NanoForge-dev/Engine/blob/0470c096970747dbf5774420f0ca1b4d47f2927f/modules/network/src/server/server.network.base.ts#L18-L20). typedoc.json setsexcludePrivatebut notexcludeProtected; library authors may need the protected members ofLibrary, so marking these@internalis probably the right fix.- Types referenced by public APIs but not exported:
NanoforgeFactoryStatic,InternalViewportState(core);ECSElement,ClassHandle(ecs);ClientRegistry,NetworkServer,Trace(network server);SceneVarsStore,AnyScene,AnySceneClass(scene). - An unresolved
{@link NfDuplicateLibraryException}inNanoforgeClient.useandNanoforgeServer.use(core). UDPServerIceConfiglinks toUDPServer, which isn't documented.
Expected: pnpm run docs with no warning, and no _ internals in the reference.
Where did you find it?
Output of pnpm run docs on branch feat/docs-navigation; page references/engine/<version>/network/server/classes/NetworkServerLibrary of the generated reference.
- 主要言語
- TypeScript
- スター
- 7
- フォーク
- 2
- 平均マージ
- 1日 17時間
- マージ済み PR（30日）
- 17
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NanoForge-dev/Engine のほかの issue
-
dependencies enhancement good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
NanoForge-dev/Engine#513 ·
メンテナーはふだん 1 日以内に返信
-
bug chore tests
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
NanoForge-dev/Engine#511 ·
メンテナーはふだん 1 日以内に返信
-
docs(network): TSDoc says ICE_SERVERS defaults to an empty list, the code uses public STUN serversオープンdocumentation good first issue modules:network
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
NanoForge-dev/Engine#509 ·
メンテナーはふだん 1 日以内に返信
-
documentation modules:ecs packages:asset packages:core
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
NanoForge-dev/Engine#508 ·
メンテナーはふだん 1 日以内に返信
-
bug good first issue modules:music modules:sound
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
NanoForge-dev/Engine#505 ·
メンテナーはふだん 1 日以内に返信
NanoForge-dev/Engine の issue をすべて見る
似ている issue
-
Mend: dependency security vulnerability
難易度 1/5 1〜3時間 初心者へのやさしさ 65/100
fdm-monster/fdm-monster#5563 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
be-BOP-io-SA/be-BOP#2849 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 79/100
メンテナーはふだん 1 日以内に返信
-
1️⃣ phase/under-investigation flaky/confirmed flaky/needs-decision type/bug
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
growilabs/growi#12246 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
🐛 The Rulekeeper - An index run that gives up on the lock ends Succeeded対応中かも @github-actions が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
SSWConsulting/SSW.Rules#2809 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信