angular / angular/angular-cli

Generate documentation for default builders

Open
#23,088 7 comments 1 reaction 0 assignees View on GitHub
area: @angular-devkit/build-angular area: docs
Dominant language
TypeScript
Stars
27k
Forks
11.8k
Avg merge
14h 23m
Merged PRs (30d)
162

Description

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.

Contributor guide

Open the contributing guide

Research direction

Start with the AIO workspace configuration page and the linked default builder schema, packages/angular_devkit/build_angular/src/builders/browser/schema.json. Trace how the schema files could be processed into documentation pages and linked from the default builders list. Done means each relevant builder has an understandable generated page and the workspace configuration links to those pages instead of directly to JSON schemas.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.