SWML Update Process

Overview

This document outlines the responsibilities and processes for both the Engineering team and the Developer Experience (DevEx) team in managing new SWML changes.

---

Engineering Responsibilities

Objective: Ensure provided information is clear and consistent for the DevEx team to make changes to the SWML schema and public documentation.

Steps

1. Create Github Issue

• Repository: signalwire-docs
• Create Issue using the SWML Update template
  • The template should ask for any required information.
• Provide a thorough description of what the change entails and where the change is located.
• Explain why these changes are being made, including any relevant background information.
• Include an example of the new or updated SWML method (optional but recommended).
• Indicate if the changes are ready for production.
• Hand-off to DevEx

---

Developer Experience (DevEx) Responsibilities

Objective: Update the SWML TypeScript types and documentation to reflect the new SWML changes provided by the Engineering team.

Update SWML TypeScript Type(s)

• Repository: swml-schema-ts
• Update Schema: Modify the TypeScript types in the repository to reflect the new or updated SWML methods provided by Engineering.
• Review and Test: Ensure the updated schema is accurate and fully tested.
• Push/Merge Changes: Push the changes and merge them into the main branch of the swml-schema-ts repo.

Update Documentation

• Repository: signalwire-docs
• Update Documentation: Use the information provided in the GitHub issue created by Engineering to update the documentation.
• Review and Approval: Assign the documentation draft for review to ensure accuracy and completeness.
• Push/Merge Documentation: Push the final version and merge it into the main branch of the signalwire-docs repo.

Announce Documentation/Schema Update

DevEx has a Zap created that will fire when any documentation has updated/merged in the internal-cx-general slack channel.