You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In our documentation, we utilize a feature where #context comments are used to add imports to code snippets, as shown below:
// #context import type { AssetId } from 'fuels';constassetId: AssetId={value: Bits256,};
This approach works well during markdown file processing, where the #context text is removed, and the relevant import is added to the code snippet.
However, there is no validation mechanism for the imports added with these #context comments.
This lack of validation can result in several issues:
Outdated Imports: Over time, some imports may become outdated or deprecated. Without validation, these obsolete imports may remain in the documentation, potentially confusing our users.
Unused Imports: Over time, we may need to update these code snippets and forget to update the #context comments, leaving imports that are no longer used in the associated code snippets. These unnecessary imports clutter the code and can mislead users regarding the actual dependencies of the code example.
We need to find a solution to validate all imports that are manually added to code snippets present on our Docs.
The text was updated successfully, but these errors were encountered:
In our documentation, we utilize a feature where
#context
comments are used to add imports to code snippets, as shown below:This approach works well during markdown file processing, where the
#context
text is removed, and the relevant import is added to the code snippet.However, there is no validation mechanism for the imports added with these
#context
comments.This lack of validation can result in several issues:
Outdated Imports: Over time, some imports may become outdated or deprecated. Without validation, these obsolete imports may remain in the documentation, potentially confusing our users.
Unused Imports: Over time, we may need to update these code snippets and forget to update the
#context
comments, leaving imports that are no longer used in the associated code snippets. These unnecessary imports clutter the code and can mislead users regarding the actual dependencies of the code example.We need to find a solution to validate all imports that are manually added to code snippets present on our Docs.
The text was updated successfully, but these errors were encountered: