diff --git a/documentation/DPG-quickstart.md b/documentation/DPG-quickstart.md index cefe2992ceaf..efe3c9d00ce6 100644 --- a/documentation/DPG-quickstart.md +++ b/documentation/DPG-quickstart.md @@ -52,7 +52,6 @@ The `package name` is used when publishing to [npmjs](https://www.npmjs.com/). I options: "@azure-tools/typespec-ts": emitter-output-dir: "{output-dir}/{service-dir}/YOUR_SERVICE_FOLDER" - is-modular-library: true package-details: name: YOUR_PACKAGE_NAME description: "SHORT_DESCRIPTION" diff --git a/documentation/Generate-code-from-TypeSpec.md b/documentation/Generate-code-from-TypeSpec.md index 5668d35f8c47..35720cc14337 100644 --- a/documentation/Generate-code-from-TypeSpec.md +++ b/documentation/Generate-code-from-TypeSpec.md @@ -36,13 +36,7 @@ You can reference these two config files to configure the Modular or RLC package - [Modular tspconfig.yaml](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml) - [RLC tspconfig.yaml](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml) -Please make sure `service-dir`, `emitter-output-dir`, `package-details`, `flavor`(for typespec-ts) is correctly configured. `experimental-extensible-enums` is the optional config. -For control-plane SDKs, the `is-modular-library` option is true by default, while for data-plane SDKs it is false. To generate Modular libraries for data-plane SDKs, you must add -``` -is-modular-library:true -``` -in your tspconfig.yaml. `is-modular-library` should be set to true unless you have been explicitly instructed by the Azure SDK Architecture Board to proceed with RLC code generation. - +Please make sure `service-dir`, `emitter-output-dir`, `package-details`, `flavor`(for typespec-ts) is correctly configured. `experimental-extensible-enums` is the optional config.The `is-modular-library` option is true by default, if you want to generate RLC libraries for data-plane SDKs, you must add `is-modular-library: false` in your tspconfig.yaml. - "parameters.service-dir.default" would be `sdk/` - "options.@azure-tools/typespec-ts.emitter-output-dir" would be `{output-dir}/{service-dir}/` diff --git a/documentation/RLC-quickstart.md b/documentation/RLC-quickstart.md index e9d5bbf431e4..53dac7afbf10 100644 --- a/documentation/RLC-quickstart.md +++ b/documentation/RLC-quickstart.md @@ -53,6 +53,7 @@ The `package name` is used when publishing to [npmjs](https://www.npmjs.com/). I options: "@azure-tools/typespec-ts": emitter-output-dir: "{output-dir}/{service-dir}/YOUR_SERVICE_FOLDER-rest" + is-modular-library: false package-details: name: YOUR_PACKAGE_NAME description: "SHORT_DESCRIPTION"