Generate documentation for default builders

Open
#23,088 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

Description

area: @angular-devkit/build-angular area: docs

AIO has a page on angular.json workspace configuration which lists default builders. Unfortunately these builders link directly to the JSON schema, 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.

Dominant language
TypeScript
Stars
27k
Forks
11.8k
Avg merge
16h 35m
Merged PRs (30d)
176

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from angular/angular-cli

All issues in angular/angular-cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.