angular / angular/angular-cli

Generate documentation for default builders

未关闭
#23,088 7 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
area: @angular-devkit/build-angular area: docs
主要语言
TypeScript
星标
27k
派生
11.8k
平均合并
14 小时 23 分钟
30 天内合并 PR
162

描述

AIO has a page on `angular.json` workspace configuration which lists [default builders](https://angular.io/guide/workspace-config#default-architect-builders-and-targets). Unfortunately these builders link directly to the [JSON schema](https://github.com/angular/angular-cli/blob/main/packages/angular_devkit/build_angular/src/builders/browser/schema.json), which is not very intuitive.

We should process these schema files and generate a page for each builder linked from the workspace configuration. This would make it much easier to understand `@angular-devkit/build-angular` and related builders' options.

贡献指南

打开贡献指南

调研方向

从 AIO 工作区配置页面和链接的默认 builder schema packages/angular_devkit/build_angular/src/builders/browser/schema.json 开始。跟踪如何将 schema 文件处理为文档页面,并从默认 builder 列表链接到这些页面。完成的标准是每个相关 builder 都有一个易于理解的生成页面,并且工作区配置链接到这些页面,而不是直接链接到 JSON schema。

由索引模型根据 Issue 内容生成。

评估

技术栈
angular, typescript
领域
build-system, documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。