Skip to content

DocumentationRelevantDeps

reference
1 min readUpdated

Kind: Interface

Source: atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts

DocumentationRelevantDeps - What to load when extracting an entity

When we extract OrderForm.tsx, we should also load:

  • orderValidationSchema.ts (FULLY - contains validation rules)
  • OrderService.create() (signature + JSDoc)
  • useOrderState hook (state shape)
  • ORDER_STATUS enum (ALL values)

Properties

PropertyType
entityIdstring
required`Array<{
entityId: string;
reason: 'validation' | 'state' | 'constants' | 'error_handling';
loadStrategy: 'full' | 'signature_only' | 'values_only';

}>| |helpful|Array<{ entityId: string; reason: string; loadStrategy: 'full' | 'signature_only'; }>| |estimatedTokens|{ required: number; helpful: number; total: number; }` |

Was this page helpful?

Download as PDF