docs(quickstart): remove zoneless note and recommend zoneless - #1452
docs(quickstart): remove zoneless note and recommend zoneless#1452chintankavathia wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the quickstart guide to recommend using a zoneless Angular application. The changes correctly modify the ng new command example and the corresponding app.config.ts setup by removing zone.js related configurations. My review includes one suggestion to improve the documentation by explicitly stating the recommendation for a zoneless setup and providing a brief rationale, which would enhance clarity for users following the guide and aligns with the rule of explaining 'the why' before 'the how'.
|
|
||
| Answer the following questions as desired. Note: We are not yet | ||
| [Zoneless](https://angular.dev/guide/zoneless). | ||
| Answer the following questions as desired. |
There was a problem hiding this comment.
While the example now correctly shows 'Yes' for a zoneless application, the accompanying text could be improved. The previous note about not being zoneless was removed, but now there's no explanation for the new recommendation. To enhance clarity, it's beneficial to explicitly state the recommendation for a zoneless setup and briefly explain the benefits (e.g., performance). This aligns with the general rule of explaining 'the why' before 'the how'.
| Answer the following questions as desired. | |
| Answer the following questions as desired. We recommend creating a zoneless application for better performance and a more modern Angular setup. |
References
- In documentation, it is preferable to introduce a concept ('the why') before detailing the technical specifics ('the how') to enhance readability, even if this leads to some repetition.
0538019 to
0a921d3
Compare
|
Documentation. Coverage Reports: |
Uh oh!
There was an error while loading. Please reload this page.