Stop shipping the `docs/` folder inside the `@angular/fire` npm package
維護者通常 2 天內回覆
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 35/100
- Issue 類型
- 功能
- 描述清晰度
- 描述清楚
- 活躍度
- 停滯
- 技術堆疊
- angular, firebase, typescript
- 領域
- build-system, release
研究方向
Read tools/build.ts and inspect the build output and package contents to confirm where docs/ is copied and that README.md remains included. The issue reports that no package code reads the copied documentation and proposes removing it from the publish output. Done means the built package excludes docs/ while preserving README.md; an open linked pull request (#3811) already addresses this work.
由索引模型根據 Issue 內容生成。
描述
The published @angular/fire tarball carries the repository's whole docs/ tree. tools/build.ts has copied it into the publish output since the 6.0.0 build script (#2282), and no code in the package reads it.
What it costs
Measured on 22.0.0-canary.20261023183021.sha-f95d598:
- 53 of the tarball's 175 files are documentation, 1,030,796 of 4,694,110 bytes unpacked.
- Without them the compressed tarball goes from 2,021,273 to 1,173,999 bytes, a 42 percent cut.
- The shipped copy freezes at the installed version while the GitHub pages move on.
- The copy includes
docs/firebase.json, a sample file. At least one published project points its App HostingrootDiratnode_modules/@angular/fire/docs/firebase.json, which the file's presence invited.
Proposal
Drop the docs/ copy from the build. README.md keeps shipping. The documentation stays where it is maintained, on GitHub.
I have not found anything that depends on the in-package path, and I would like to hear about it if you have.
- 主要語言
- TypeScript
- 星號
- 7.8k
- 分支
- 2.2k
- 平均合併
- 2 天 6 小時
- 30 天內合併 PR
- 16
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
angular/angularfire 的其他 Issue
-
The v21 upgrade guide says only `getImagenModel` was removed from the AI API可能已有人在做 @armando-navarro 於 2 天前認領。 未關閉comp: ai comp: docs type: chore version: current (v17+)
難度 1/5 1-3 小時 新手友好度 35/100
angular/angularfire#3816 ·
維護者通常 2 天內回覆
-
The auth guide and the sample still import `beforeAuthStateChanged` from `firebase/auth`可能已有人在做 @armando-navarro 於 2 天前認領。 未關閉comp: auth comp: docs type: chore version: current (v17+)
難度 2/5 1-3 小時 新手友好度 25/100
angular/angularfire#3815 ·
維護者通常 2 天內回覆
-
The docs on 21.0.x still describe AngularFire 21 as a release candidate可能已有人在做 @armando-navarro 於 2 天前認領。 未關閉comp: docs type: chore version: current (v17+)
難度 2/5 1-3 小時 新手友好度 35/100
angular/angularfire#3812 ·
維護者通常 2 天內回覆
-
Move the repo's build and test targets off the deprecated `@angular-devkit/build-angular` builders可能已有人在做 @armando-navarro 於 2 天前認領。 未關閉comp: build/pipeline type: chore
難度 4/5 1-2 天 新手友好度 25/100
angular/angularfire#3806 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 55/100
angular/angularfire#3800 · 1 個 reaction ·
維護者通常 2 天內回覆
查看 angular/angularfire 的全部 Issue
相似的 Issue
-
bug
難度 2/5 1-3 小時 新手友好度 68/100
outline/outline#14348 · 1 則留言 ·
維護者通常 1 天內回覆
-
bug needs-triage
難度 2/5 1-3 小時 新手友好度 68/100
維護者通常 1 天內回覆
-
[Bug]: Agent import retains quotes in .env API keys followed by inline comments可能已有人在做 @yxr-2025 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 82/100
維護者通常 1 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 76/100
awslabs/visual-asset-management-system#804 ·
維護者通常 1 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 68/100
dsh-market/dsh-market#1027 · 1 則留言 ·
維護者通常 1 天內回覆