Debt Team Documentation Audit - Front End Discovery

[alatempa24]

Issue Description

The Debt team is conducting a product documentation audit. All team members are being asked to help get this documentation up to date.

This issue is to timebox front end discovery into what documentation needs to be added to the audit document.

---

Tasks

• [ ] Review what is currently on the Product Documentation Audit doc
• [ ] Identify any helpful other documentation needs and record them on the ticket

Acceptance Criteria

• [ ] List of what documentation needs to be added to the audit doc

  How to configure this issue

• [ ] Attached to a Milestone (when will this be completed?)
• [ ] Attached to an Epic (what body of work is this a part of?)
• [ ] Labeled with Team (product support, analytics-insights, operations, service-design, Console-Services, tools-fe)
• [ ] Labeled with Practice Area (backend, frontend, devops, design, research, product, ia, qa, analytics, contact center, research, accessibility, content)
• [ ] Labeled with Type (bug, request, discovery, documentation, etc.)

[amponce]

Created documentation for useDetectFieldChanges,

[amponce]

Documentation List for Frontend:

1. Custom Components:

   • Document the purpose and structure of custom components and how to use or extend them.

2. Form Configuration and Chapters:

   • Explain how forms are configured, including the structure of chapters and custom review pages.

3. Schema and Pages:

   • Overview of how the schema handles validation and form rendering, with an option to use custom components.

4. Logic and Data:

   • Summarize the key logic for handling streamlined waiver processes, including how eligibility is determined.
   • Explain the transform function for formatting form data before submission.
   • Document how the frontend calls a backend API for income and asset calculations, including error handling.

5. Actions and Hooks:

   • Provide a brief explanation of actions and custom hooks, including how they are used in state management.

6. Feature Flags:

   • Overview of how feature flags are configured and used within the application.

7. Tests:

   • Summarize the testing strategy, including how to write tests and use mocks.

8. Utilities (Utils):

   • Briefly document common utility functions and how they are organized.

9. Miscellaneous:

   • Explain the basics of styling with SASS, manifest configuration, app entry points, and routing.

[amponce]

@Tom-Davis To document list is completed ^^