Skip to content

docs(sdd): bootstrap react-widgets specifications - #1468

Open
vivekv1504 wants to merge 1 commit into
webex:masterfrom
vivekv1504:react-widgets-migrate-into-sdd-bootstrap
Open

docs(sdd): bootstrap react-widgets specifications#1468
vivekv1504 wants to merge 1 commit into
webex:masterfrom
vivekv1504:react-widgets-migrate-into-sdd-bootstrap

Conversation

@vivekv1504

@vivekv1504 vivekv1504 commented Jul 23, 2026

Copy link
Copy Markdown

COMPLETES #< INSERT LINK TO ISSUE >

This pull request addresses

< DESCRIBE THE CONTEXT OF THE ISSUE >

by making the following changes

< DESCRIBE YOUR CHANGES >

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
    < ENUMERATE TESTS PERFORMED, WHETHER MANUAL OR AUTOMATED >

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
  • 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

@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-1468.d1l3lxgizk4iez.amplifyapp.com

@vivekv1504
vivekv1504 marked this pull request as ready for review July 31, 2026 10:37

@akulakum akulakum left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SDD spec-validation review

Verdict: Blocked (methodology/process gates — doc content quality is otherwise strong)

Blocking

  • validation.source_commit is base SHA, not PR HEAD
  • Missing validation.status while docs claim validation passed
  • No reviewable conformance / questionnaire / source-fidelity evidence for reconcile bootstrap
  • PR template incomplete; validated label premature

Important

  • Restore template metadata HTML blocks on all generated Markdown files
  • Sync module spec Validation status rows with manifest after re-validation

Passed checks

  • Comprehensive CONTRACTS.md
  • K1 Blocking in REVIEW_CHECKLIST.md
  • Honest reconcile handling of stale README/event examples
  • Detailed module specs with error sections where profiles require them

Please address inline comments and re-run independent spec-validator at 990470ca before merge.

Comment thread .sdd/manifest.json
"runtime_fallback_tier": "different-runtime",
"minimum_independence": "different-runtime",
"blocking_severities": ["Blocking"],
"source_commit": "145a23ef33af4e74d8790832062d9910cd66b3de",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

validation.source_commit is set to the merge-base SHA (145a23ef…), not this PR's HEAD (990470ca…). That makes the validation record non-reproducible against the docs being reviewed.

Please update the full validation block atomically after re-validation at HEAD:

  • source_commit: 990470cac7cee8abecac62ad385cbdc6adb85412
  • validation.status: pass-with-warnings or blocked (not omitted)
  • validator_runtime, validator_run_id, runtime_fallback_tier, etc.

Do not update only source_commit while leaving the old validator_run_id.

Comment thread .sdd/manifest.json
{
"path": "packages/node_modules/@webex/widget-space/",
"coverage_status": "Partial",
"coverage_evidence": "Documentation assessment 94%: public exports, events, configuration, state, UI, error paths, and journey intent are covered; independent Cursor validation passed, while the last-five-PR drift gate still blocks promotion.",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All modules show 91–96% documentation scores but remain Partial. That may be correct (promotion-history / drift gates), but it is not obvious from the PR alone.

Please add a short note in the PR description explaining why high scores still map to Partial (e.g. last-five-PR drift gate, characterization gaps, promotion history).

Comment thread AGENTS.md

---

Per-module coverage state lives in `.sdd/manifest.json` and is mirrored in `ai-docs/SPEC_INDEX.md`. Independent Cursor validation passed on 2026-07-23; the bootstrap specs remain `Partial` until their documented weak-evidence gaps and the promotion-history gate are satisfied.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This states "Independent Cursor validation passed on 2026-07-23," but .sdd/manifest.json has no validation.status and source_commit points at base, not HEAD.

Please align narrative with committed validation metadata, or downgrade the claim until validation at 990470ca is recorded.

| Coverage score | 93% assessed 2026-07-22; enhancer order, host APIs, auth, teardown, and demo boundaries covered |
| Generated from | `module-spec` @ SDLC template library `0.2.1` |
| generated_by / approved_by / updated_at | `codex-desktop` / repository owner / 2026-07-23 |
| Validation status | independent Cursor validation passed on 2026-07-23 with zero Blocking findings |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Metadata says "independent Cursor validation passed … zero Blocking findings," but manifest validation metadata is incomplete and not tied to HEAD.

Please sync Validation status rows in all module specs with committed manifest after re-validation, e.g.:
pass-with-warnings, validator codex-agent-session, assessed YYYY-MM-DD (0 blocking)

Keep approved_by: pending PR approval until merge if still draft. (Same comment applies to all ai-docs/modules/*-spec.md files.)

Comment thread .sdd/manifest.json
"blocking_severities": ["Blocking"],
"source_commit": "145a23ef33af4e74d8790832062d9910cd66b3de",
"base_ref": "master",
"head_ref": "react-widgets-migrate-into-sdd-bootstrap"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The manifest records validator runtime/run id but has no validation.status. Meanwhile AGENTS.md and module specs say "Independent Cursor validation passed."

Either:

  1. Record the approved verdict in manifest (pass-with-warnings / pass / blocked), or
  2. Change doc wording to "validation pending" until Session B metadata is committed at HEAD.

Same issue fixed in webex/components#859.

Comment thread AGENTS.md
@@ -0,0 +1,113 @@
# AGENTS.md — react-widgets

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These generated docs are missing the hidden template metadata block (Template, Template-ID, Generates, library version, last updated). Footer Generated from rows are helpful but do not replace the template-library provenance block.

Please restore it across all generated Markdown files (standing docs, patterns, rules, module specs, ADRs) per template-library v0.2.1 — same fix required in components#859.


## Decision

Preserve protected source documents unchanged. Reorganize supported meaning into canonical SDD sections, use current source/tests to resolve conflicts, and keep unit-level disposition in ignored source-fidelity inventories. Canonical specs do not embed full-file snapshots.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reconcile mode requires reviewable source-fidelity evidence (A14). This ADR says inventories live only in gitignored .generated/, which reviewers cannot verify from the PR.

Please attach a redacted summary in the PR (unit counts: mapped / stale / conflicting / native-reference) so we can confirm protected READMEs/events/testplan meaning was preserved without full-file snapshots.

Comment thread ai-docs/CONTRACTS.md
| `rw.cmd.publish` | build-release-tooling | `npm run publish:components` | CI/registry environment | nonzero on build/publish failure | protected release operation | `package.json`, `scripts/utils/publish.js` |
| `rw.cmd.release` | build-release-tooling | `npm run release` | standard-version args | nonzero on version/changelog failure | Conventional Commits | `package.json` |

## Requires — what this repo depends on

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Requires table content is strong, but column headers differ from the template (Schema / detail link, Availability assumption, Fallback on failure, Version floor).

Consider aligning column naming/shape with template-library v0.2.1 for conformance consistency.


| # | Check | When it applies | What it verifies | Severity |
|---|---|---|---|---|
| K1 | Regression guard | Any Partial/Untracked module or MODIFIED/REMOVED guarantee | A characterization/targeted baseline protects unchanged behavior with positive and negative cases. | Blocking |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

K1 is correctly Blocking with positive/negative characterization semantics — matches template v0.2.1. Good improvement vs early components bootstrap drafts.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants