Skip to content

docs(ai-docs): migrate to SDLC-Templates component-repo standard#707

Draft
bhabalan wants to merge 1 commit into
webex:nextfrom
bhabalan:docs/sdlc-templates-migration
Draft

docs(ai-docs): migrate to SDLC-Templates component-repo standard#707
bhabalan wants to merge 1 commit into
webex:nextfrom
bhabalan:docs/sdlc-templates-migration

Conversation

@bhabalan

Copy link
Copy Markdown
Contributor

COMPLETES #N/A — internal documentation/tooling migration (no Jira issue)

This pull request addresses

The repository's AI documentation did not follow the org-wide SDLC-Templates component-repo standard (library version 0.1.0-draft). Docs were spread across per-package AGENTS.md/ARCHITECTURE.md pairs with no machine-readable source of truth, no spec router, and no per-module spec format.

by making the following changes

Reshaped the repo's AI documentation to conform to the SDLC-Templates component-repo standard.

Standing docs (repo-level, ai-docs/):

  • Reshaped root AGENTS.md into the agent-entry contract
  • Added SPEC_INDEX.md (router + module registry) and ARCHITECTURE.md
  • Added RULES, GLOSSARY, SECURITY, CONTRACTS, GETTING_STARTED, REVIEW_CHECKLIST, SERVICE_STATE
  • Added adr/ and rules/ scaffolds with seed entries

Machine source of truth (.sdd/):

  • manifest.json — per-module coverage state, commands, contracts pointers (tracked via a .gitignore exception)
  • coverage-policy.defaults.yaml — drift thresholds + changed-line coverage bar

Per-module specs (<module>/ai-docs/<module>-spec.md) for: store, cc-components, cc-widgets, station-login, user-state, task, ui-logging, test-fixtures, and legacy @webex/widgets.

Archived, not deleted: pre-standard per-package AGENTS.md/ARCHITECTURE.md pairs are preserved under ai-docs/_archive/pre-sdlc-migration/.

Documentation-only change — no source code, build, or runtime behavior is affected.

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
  • Documentation-only change; no application code paths affected.
  • Verified all relative doc links resolve (164/164) and every module spec contains all required universal sections in template order.
  • Existing unit suites (cc-widgets, meetings, tooling) are unchanged by this PR.

The GAI Coding Policy And Copyright Annotation Best Practices

  • GAI was used to create a draft that was subsequently customized or modified
  • Tool used for AI assistance (GitHub Copilot / Other - specify)
    • Github Copilot
    • Other - Please Specify: Claude Code
  • This PR is related to
    • Feature
    • Defect fix
    • Tech Debt
    • Automation

Checklist before merging

  • I have not skipped any automated checks (CI checks run on PR; documentation-only change)
  • All existing and new tests passed (unit suites unaffected by docs-only change)
  • I have updated the testing document
  • I have tested the functionality with amplify link

Reshape the repo's AI documentation to conform to the SDLC-Templates
component-repo standard (library version 0.1.0-draft).

Standing docs (repo-level, ai-docs/):
- Reshape root AGENTS.md into the agent-entry contract
- Add SPEC_INDEX.md (router + module registry), ARCHITECTURE.md
- Add RULES, GLOSSARY, SECURITY, CONTRACTS, GETTING_STARTED,
  REVIEW_CHECKLIST, SERVICE_STATE
- Add adr/ and rules/ scaffolds with seed entries

Machine source of truth:
- .sdd/manifest.json (per-module coverage state, commands, contracts)
- .sdd/coverage-policy.defaults.yaml (drift thresholds, coverage bar)
- Track .sdd/manifest.json via .gitignore exception

Per-module specs (source-local <module>/ai-docs/<module>-spec.md):
- store, cc-components, cc-widgets, station-login, user-state, task,
  ui-logging, test-fixtures, and legacy @webex/widgets

Pre-standard per-package AGENTS.md/ARCHITECTURE.md pairs are preserved
under ai-docs/_archive/pre-sdlc-migration/ rather than deleted.
@aws-amplify-us-east-2

Copy link
Copy Markdown

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant