Skip to content

Conversation

@ciscoRankush
Copy link
Contributor

@ciscoRankush ciscoRankush commented Feb 9, 2026

COMPLETES - Documentation Enhancement

This pull request addresses

The need to make AI agent workflow and constraints in the repository explicit and consistent. The root AGENTS.md is the main orchestrator for AI assistants; it needed clearer instructions so that agents (1) identify task type, (2) load the correct package/widget ai-docs when working in that scope, (3) complete mandatory pre-steps before generating code, and (4) use a single reference table for all package/widget documentation paths.

by making the following changes

  • Request workflow: Added a "For every developer request" checklist at the top (identify task type → load scope ai-docs → complete template pre-steps → follow guide and template).
  • Quick Start: Expanded steps to include loading package/widget ai-docs and completing mandatory pre-steps before code generation; renumbered steps accordingly.
  • CRITICAL RULES: Added Rule 3 (must use package/widget ai-docs when working in that scope) and Rule 4 (must complete template pre-steps before code), with a table mapping task types (A–E) to templates and mandatory pre-steps.
  • Step 2 – Load Context: Replaced scattered package-doc bullets with a single Package and widget ai-docs reference table (paths for station-login, user-state, task widgets, store, cc-components, cc-widgets, ui-logging, samples-cc-react-app). Clarified that the task package uses per-widget ai-docs (CallControl, IncomingTask, OutdialCall, TaskList).
  • Task type E (Understanding): Updated to reference the new ai-docs table and to list task package widgets explicitly.

Change Type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios were tested

  • The testing is done with the amplify link
  • Manual review of AGENTS.md for correctness, link validity, and consistency with existing templates and ai-docs structure.
  • No code or runtime behavior changed; no amplify or automated functional testing required for this documentation-only update.

The GAI Coding Policy And Copyright Annotation Best Practices

  • GAI was not used (or, no additional notation is required)
  • Code was generated entirely by GAI
  • GAI was used to create a draft that was subsequently customized or modified
  • Coder created a draft manually that was non-substantively modified by GAI (e.g., refactoring was performed by GAI on manually written code)
  • Tool used for AI assistance (GitHub Copilot / Other - specify)
    • Github Copilot
    • Other - Please Specify : CURSOR
  • This PR is related to
    • Feature
    • Defect fix
    • Tech Debt
    • Automation

Checklist before merging

  • I have not skipped any automated checks
  • All existing and new tests passed
  • I have updated the testing document
  • I have tested the functionality with amplify link

Make sure to have followed the contributing guidelines before submitting.

Co-authored-by: Cursor <[email protected]>
@aws-amplify-us-east-2
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-618.d1b38q61t1z947.amplifyapp.com

@Shreyas281299 Shreyas281299 added the validated Indicates that the PR is ready for actions label Feb 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

validated Indicates that the PR is ready for actions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants