Skip to content

docs(tooling): bootstrap SDD foundation for sdk-component-adapter - #354

Open
akulakum wants to merge 10 commits into
webex:masterfrom
akulakum:SDLC_SKILLS_FOR_SDK_COMPONENT_ADAPTER
Open

docs(tooling): bootstrap SDD foundation for sdk-component-adapter#354
akulakum wants to merge 10 commits into
webex:masterfrom
akulakum:SDLC_SKILLS_FOR_SDK_COMPONENT_ADAPTER

Conversation

@akulakum

@akulakum akulakum commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

COMPLETES SPARK-843154

This pull request addresses

The @webex/sdk-component-adapter repository had no Spec Driven Development (SDD) foundation. Agents and contributors lacked canonical, code-grounded docs for adapter modules, public contracts, and lifecycle behavior (connect/disconnect, RxJS surfaces).

by making the following changes

Bootstrap SDD Stage 0 (rigorous mode, keep-separate policy):

  • Add AGENTS.md — agent entry contract, commands, and doc routing
  • Add standing docs under ai-docs/ (ARCHITECTURE, CONTRACTS, SPEC_INDEX, GETTING_STARTED, RULES, GLOSSARY, SECURITY, REVIEW_CHECKLIST)
  • Add two code-grounded patterns under ai-docs/patterns/
  • Add nine canonical module specs under src/ai-docs/ (facade + 7 domain adapters + shared utilities)
  • Add .sdd/manifest.json — module routing, coverage state, contracts, validation config
  • Update .gitignore to exclude .generated/ temporary SDD artifacts

Policy: README, CONTRIBUTING, dependencies, and CHANGELOG remain unchanged (reference-only).

Not committed: .cursor/, .agents/, .claude/, .sdd/templates/, .sdd/metrics/ (local SDD skill install only).

Module coverage (Partial, ~90% aggregate)

Module Spec
webex-sdk-adapter src/ai-docs/webex-sdk-adapter-spec.md
meetings-sdk-adapter src/ai-docs/meetings-sdk-adapter-spec.md
activities-sdk-adapter src/ai-docs/activities-sdk-adapter-spec.md
people-sdk-adapter src/ai-docs/people-sdk-adapter-spec.md
rooms-sdk-adapter src/ai-docs/rooms-sdk-adapter-spec.md
memberships-sdk-adapter src/ai-docs/memberships-sdk-adapter-spec.md
organizations-sdk-adapter src/ai-docs/organizations-sdk-adapter-spec.md
metrics-sdk-adapter src/ai-docs/metrics-sdk-adapter-spec.md
shared-utilities src/ai-docs/shared-utilities-spec.md

Follow-up: Session B independent spec-validator on a different runtime before marking SDD validation pass.

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 runtime code modified
  • Verified generated docs against source: src/WebexSDKAdapter.js connect/disconnect order, src/index.js export surface, rollup.config.js bundle outputs, .circleci/config.yml CI workflow
  • Existing unit/integration tests unchanged; no new test failures expected

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 Agent (SDD Bootstrap generator)
  • 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

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