guides-source icon indicating copy to clipboard operation
guides-source copied to clipboard

[Documentation] Mention `tracked-tools` in Autotracking Guide

Open ChaiWithJai opened this issue 2 years ago • 0 comments

📙 Describe the Issue

The Autotracking In-Depth Guides in the Ember documentation currently do not mention the usage of tracked-tools (https://github.com/tracked-tools). This library provides additional utilities for autotracking in Ember and could be beneficial to developers working with Ember's autotracking feature with composite data types (arrays and objects in particular).

🔬 Minimal Reproduction

  1. Visit the Autotracking In-Depth Guides page: https://guides.emberjs.com/release/in-depth-topics/autotracking-in-depth/
  2. Read through the guides. Read the section about tracking arrays and objects. There might be an opportunity to enhance the following copy "Instead, you can continue to use EmberArray, which will continue to work with tracking and will cause any dependencies that use it to invalidate correctly.".

😕 Actual Behavior

The current Ember guides do not reference or mention the use of tracked-tools in the context of autotracking, potentially leaving developers unaware of these additional, helpful utilities.

🤔 Expected Behavior

Should we mention tracked-tools? I realize this may be addressed when Polaris is released, however, its a common enough use case for folks new to Ember or new to Octane.

➕ Additional Context

tracked-tools is a library that provides additional utilities for autotracking in Ember. It is an important tool that can enhance the developer experience when working with autotracking, hence it would be beneficial for this tool to be included in the Ember documentation.

Was originally posted in the main repo.

ChaiWithJai avatar Jul 05 '23 23:07 ChaiWithJai