docs(misc): documentation headers should include collectionName for searchability (#6451)

Signed-off-by: AgentEnder <craigorycoppola@gmail.com>
This commit is contained in:
Craigory V Coppola 2021-07-21 10:40:59 -05:00 committed by GitHub
parent 9044a8f869
commit a1ccc87a07
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
284 changed files with 293 additions and 284 deletions

View File

@ -1,4 +1,4 @@
# delegate-build # @nrwl/angular:delegate-build
Delegates the build to a different target while supporting incremental builds. Delegates the build to a different target while supporting incremental builds.

View File

@ -1,4 +1,4 @@
# ng-packagr-lite # @nrwl/angular:ng-packagr-lite
Builds a library with support for incremental builds. Builds a library with support for incremental builds.

View File

@ -1,4 +1,4 @@
# package # @nrwl/angular:package
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds. Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.

View File

@ -1,4 +1,4 @@
# webpack-browser # @nrwl/angular:webpack-browser
Builds a browser application with support for incremental builds and custom webpack configuration. Builds a browser application with support for incremental builds and custom webpack configuration.

View File

@ -1,4 +1,4 @@
# webpack-server # @nrwl/angular:webpack-server
Serves a browser application with support for a custom webpack configuration. Serves a browser application with support for a custom webpack configuration.

View File

@ -1,4 +1,4 @@
# application # @nrwl/angular:application
Creates an Angular application. Creates an Angular application.

View File

@ -1,4 +1,4 @@
# convert-tslint-to-eslint # @nrwl/angular:convert-tslint-to-eslint
Converts a project from TSLint to ESLint. Converts a project from TSLint to ESLint.

View File

@ -1,4 +1,4 @@
# downgrade-module # @nrwl/angular:downgrade-module
Sets up a Downgrade Module. Sets up a Downgrade Module.

View File

@ -1,4 +1,4 @@
# karma-project # @nrwl/angular:karma-project
Adds Karma configuration to a project. Adds Karma configuration to a project.

View File

@ -1,4 +1,4 @@
# karma # @nrwl/angular:karma
Adds Karma configuration to a workspace. Adds Karma configuration to a workspace.

View File

@ -1,4 +1,4 @@
# library # @nrwl/angular:library
Creates an Angular library. Creates an Angular library.

View File

@ -1,4 +1,4 @@
# move # @nrwl/angular:move
Moves an Angular application or library to another folder within the workspace and updates the project configuration. Moves an Angular application or library to another folder within the workspace and updates the project configuration.

View File

@ -1,4 +1,4 @@
# ngrx # @nrwl/angular:ngrx
Adds NgRx support to an application or library. Adds NgRx support to an application or library.

View File

@ -1,4 +1,4 @@
# setup-mfe # @nrwl/angular:setup-mfe
Generate a Module Federation configuration for a given Angular application. Generate a Module Federation configuration for a given Angular application.

View File

@ -1,4 +1,4 @@
# stories # @nrwl/angular:stories
Creates stories/specs for all components declared in a project. Creates stories/specs for all components declared in a project.

View File

@ -1,4 +1,4 @@
# storybook-configuration # @nrwl/angular:storybook-configuration
Adds Storybook configuration to a project. Adds Storybook configuration to a project.

View File

@ -1,4 +1,4 @@
# storybook-migrate-defaults-5-to-6 # @nrwl/angular:storybook-migrate-defaults-5-to-6
Generates default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x. Generates default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.

View File

@ -1,4 +1,4 @@
# storybook-migrate-stories-to-6-2 # @nrwl/angular:storybook-migrate-stories-to-6-2
Migrates stories to match the new syntax in v6.2 where the component declaration should be in the default export. Migrates stories to match the new syntax in v6.2 where the component declaration should be in the default export.

View File

@ -1,4 +1,4 @@
# upgrade-module # @nrwl/angular:upgrade-module
Sets up an Upgrade Module. Sets up an Upgrade Module.

View File

@ -1,4 +1,4 @@
# web-worker # @nrwl/angular:web-worker
Creates a Web Worker. Creates a Web Worker.

View File

@ -1,4 +1,4 @@
# cypress # @nrwl/cypress:cypress
Run Cypress e2e tests Run Cypress e2e tests

View File

@ -1,4 +1,4 @@
# application # @nrwl/express:application
Create an express application Create an express application

View File

@ -1,4 +1,4 @@
# build # @nrwl/gatsby:build
Build a Gatsby app Build a Gatsby app

View File

@ -1,4 +1,4 @@
# server # @nrwl/gatsby:server
Starts server for app Starts server for app

View File

@ -1,4 +1,4 @@
# application # @nrwl/gatsby:application
Create an application Create an application

View File

@ -1,4 +1,4 @@
# component # @nrwl/gatsby:component
Create a component Create a component

View File

@ -1,4 +1,4 @@
# page # @nrwl/gatsby:page
Create a page Create a page

View File

@ -1,4 +1,4 @@
# jest # @nrwl/jest:jest
Run Jest unit tests Run Jest unit tests

View File

@ -1,4 +1,4 @@
# eslint # @nrwl/linter:eslint
Run ESLint on a project Run ESLint on a project

View File

@ -1,4 +1,4 @@
# lint # @nrwl/linter:lint
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0 **[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0

View File

@ -1,4 +1,4 @@
# application # @nrwl/nest:application
Create a NestJS application. Create a NestJS application.

View File

@ -1,4 +1,4 @@
# class # @nrwl/nest:class
Run the `class` NestJS generator with Nx project support. Run the `class` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# controller # @nrwl/nest:controller
Run the `controller` NestJS generator with Nx project support. Run the `controller` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# convert-tslint-to-eslint # @nrwl/nest:convert-tslint-to-eslint
Convert a project from TSLint to ESLint. Convert a project from TSLint to ESLint.

View File

@ -1,4 +1,4 @@
# decorator # @nrwl/nest:decorator
Run the `decorator` NestJS generator with Nx project support. Run the `decorator` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# filter # @nrwl/nest:filter
Run the `filter` NestJS generator with Nx project support. Run the `filter` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# gateway # @nrwl/nest:gateway
Run the `gateway` NestJS generator with Nx project support. Run the `gateway` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# guard # @nrwl/nest:guard
Run the `guard` NestJS generator with Nx project support. Run the `guard` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# interceptor # @nrwl/nest:interceptor
Run the `interceptor` NestJS generator with Nx project support. Run the `interceptor` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# interface # @nrwl/nest:interface
Run the `interface` NestJS generator with Nx project support. Run the `interface` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# library # @nrwl/nest:library
Create a new NestJS library. Create a new NestJS library.

View File

@ -1,4 +1,4 @@
# middleware # @nrwl/nest:middleware
Run the `middleware` NestJS generator with Nx project support. Run the `middleware` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# module # @nrwl/nest:module
Run the `module` NestJS generator with Nx project support. Run the `module` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# pipe # @nrwl/nest:pipe
Run the `pipe` NestJS generator with Nx project support. Run the `pipe` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# provider # @nrwl/nest:provider
Run the `provider` NestJS generator with Nx project support. Run the `provider` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# resolver # @nrwl/nest:resolver
Run the `resolver` NestJS generator with Nx project support. Run the `resolver` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# service # @nrwl/nest:service
Run the `service` NestJS generator with Nx project support. Run the `service` NestJS generator with Nx project support.

View File

@ -1,4 +1,4 @@
# build # @nrwl/next:build
Build a Next.js app Build a Next.js app

View File

@ -1,4 +1,4 @@
# export # @nrwl/next:export
Export a Next.js app. The exported application is located at dist/$outputPath/exported. Export a Next.js app. The exported application is located at dist/$outputPath/exported.

View File

@ -1,4 +1,4 @@
# server # @nrwl/next:server
Serve a Next.js app Serve a Next.js app

View File

@ -1,4 +1,4 @@
# application # @nrwl/next:application
Create a Next.js application Create a Next.js application

View File

@ -1,4 +1,4 @@
# component # @nrwl/next:component
Create a React component Create a React component

View File

@ -1,4 +1,4 @@
# page # @nrwl/next:page
Create a Next.js page component Create a Next.js page component

View File

@ -1,4 +1,4 @@
# build # @nrwl/node:build
Build a Node application Build a Node application

View File

@ -1,4 +1,4 @@
# execute # @nrwl/node:execute
Execute a Node application Execute a Node application

View File

@ -1,4 +1,4 @@
# package # @nrwl/node:package
Package a Node library Package a Node library

View File

@ -1,4 +1,4 @@
# application # @nrwl/node:application
Create a node application Create a node application

View File

@ -1,4 +1,4 @@
# library # @nrwl/node:library
Create a library Create a library

View File

@ -1,4 +1,4 @@
# migrate-to-webpack-5 # @nrwl/node:migrate-to-webpack-5
Add webpack 5 compatible dependencies to the workspace Add webpack 5 compatible dependencies to the workspace

View File

@ -1,4 +1,4 @@
# e2e # @nrwl/nx-plugin:e2e
Creates and runs the e2e tests for an Nx Plugin. Creates and runs the e2e tests for an Nx Plugin.

View File

@ -1,4 +1,4 @@
# executor # @nrwl/nx-plugin:executor
Create a executor for an Nx Plugin Create a executor for an Nx Plugin

View File

@ -1,4 +1,4 @@
# generator # @nrwl/nx-plugin:generator
Create a generator for an Nx Plugin Create a generator for an Nx Plugin

View File

@ -1,4 +1,4 @@
# migration # @nrwl/nx-plugin:migration
Create a migration for an Nx Plugin Create a migration for an Nx Plugin

View File

@ -1,4 +1,4 @@
# plugin # @nrwl/nx-plugin:plugin
Create a Nx Plugin Create a Nx Plugin

View File

@ -1,4 +1,4 @@
# application # @nrwl/react:application
Create an application Create an application

View File

@ -1,4 +1,4 @@
# component-cypress-spec # @nrwl/react:component-cypress-spec
Create a cypress spec for a ui component that has a story Create a cypress spec for a ui component that has a story

View File

@ -1,4 +1,4 @@
# component-story # @nrwl/react:component-story
Generate storybook story for a react component Generate storybook story for a react component

View File

@ -1,4 +1,4 @@
# component # @nrwl/react:component
Create a component Create a component

View File

@ -1,4 +1,4 @@
# library # @nrwl/react:library
Create a library Create a library

View File

@ -1,4 +1,4 @@
# redux # @nrwl/react:redux
Create a redux slice for a project Create a redux slice for a project

View File

@ -1,4 +1,4 @@
# stories # @nrwl/react:stories
Create stories/specs for all components declared in a library Create stories/specs for all components declared in a library

View File

@ -1,4 +1,4 @@
# storybook-configuration # @nrwl/react:storybook-configuration
Set up storybook for a react library Set up storybook for a react library

View File

@ -1,4 +1,4 @@
# storybook-migrate-defaults-5-to-6 # @nrwl/react:storybook-migrate-defaults-5-to-6
Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x. Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.

View File

@ -1,4 +1,4 @@
# build # @nrwl/storybook:build
Build Storybook Build Storybook

View File

@ -1,4 +1,4 @@
# storybook # @nrwl/storybook:storybook
Serve Storybook Serve Storybook

View File

@ -1,4 +1,4 @@
# configuration # @nrwl/storybook:configuration
Add storybook configuration to a ui library or an application Add storybook configuration to a ui library or an application

View File

@ -1,4 +1,4 @@
# cypress-project # @nrwl/storybook:cypress-project
Add cypress e2e app to test a ui library that is set up for storybook Add cypress e2e app to test a ui library that is set up for storybook

View File

@ -1,4 +1,4 @@
# migrate-defaults-5-to-6 # @nrwl/storybook:migrate-defaults-5-to-6
Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x. Generate default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.

View File

@ -1,4 +1,4 @@
# migrate-stories-to-6-2 # @nrwl/storybook:migrate-stories-to-6-2
Migrate stories syntax to 6.2 Migrate stories syntax to 6.2

View File

@ -1,4 +1,4 @@
# build # @nrwl/web:build
Build a application Build a application

View File

@ -1,4 +1,4 @@
# dev-server # @nrwl/web:dev-server
Serve a web application Serve a web application

View File

@ -1,4 +1,4 @@
# file-server # @nrwl/web:file-server
Serve a web application from a folder Serve a web application from a folder

View File

@ -1,4 +1,4 @@
# package # @nrwl/web:package
Package a library Package a library

View File

@ -1,4 +1,4 @@
# application # @nrwl/web:application
Create an application Create an application

View File

@ -1,4 +1,4 @@
# migrate-to-webpack-5 # @nrwl/web:migrate-to-webpack-5
Add webpack 5 compatible dependencies to the workspace Add webpack 5 compatible dependencies to the workspace

View File

@ -1,4 +1,4 @@
# run-commands # @nrwl/workspace:run-commands
Run any custom commands with Nx Run any custom commands with Nx

View File

@ -1,4 +1,4 @@
# run-script # @nrwl/workspace:run-script
Run an npm script using Nx Run an npm script using Nx

View File

@ -1,4 +1,4 @@
# tsc # @nrwl/workspace:tsc
Build a project using TypeScript. Build a project using TypeScript.

View File

@ -1,4 +1,4 @@
# convert-to-nx-project # @nrwl/workspace:convert-to-nx-project
Moves a project's configuration outside of workspace.json Moves a project's configuration outside of workspace.json

View File

@ -1,4 +1,4 @@
# library # @nrwl/workspace:library
Create a library Create a library

View File

@ -1,4 +1,4 @@
# move # @nrwl/workspace:move
Move an application or library to another folder Move an application or library to another folder

View File

@ -1,4 +1,4 @@
# remove # @nrwl/workspace:remove
Remove an application or library Remove an application or library

View File

@ -1,4 +1,4 @@
# run-commands # @nrwl/workspace:run-commands
Generates a target to run any command in the terminal Generates a target to run any command in the terminal

View File

@ -1,4 +1,4 @@
# workspace-generator # @nrwl/workspace:workspace-generator
Generates a workspace generator Generates a workspace generator

View File

@ -1,4 +1,4 @@
# delegate-build # @nrwl/angular:delegate-build
Delegates the build to a different target while supporting incremental builds. Delegates the build to a different target while supporting incremental builds.

View File

@ -1,4 +1,4 @@
# ng-packagr-lite # @nrwl/angular:ng-packagr-lite
Builds a library with support for incremental builds. Builds a library with support for incremental builds.

View File

@ -1,4 +1,4 @@
# package # @nrwl/angular:package
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds. Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.

View File

@ -1,4 +1,4 @@
# webpack-browser # @nrwl/angular:webpack-browser
Builds a browser application with support for incremental builds and custom webpack configuration. Builds a browser application with support for incremental builds and custom webpack configuration.

View File

@ -1,4 +1,4 @@
# webpack-server # @nrwl/angular:webpack-server
Serves a browser application with support for a custom webpack configuration. Serves a browser application with support for a custom webpack configuration.

View File

@ -1,4 +1,4 @@
# application # @nrwl/angular:application
Creates an Angular application. Creates an Angular application.

Some files were not shown because too many files have changed in this diff Show More