{"id":30269105,"url":"https://github.com/signalwire/docs","last_synced_at":"2025-08-16T01:40:05.302Z","repository":{"id":268946186,"uuid":"905923554","full_name":"signalwire/docs","owner":"signalwire","description":"The source for the SignalWire Docs website.","archived":false,"fork":false,"pushed_at":"2025-08-13T00:00:50.000Z","size":128481,"stargazers_count":6,"open_issues_count":111,"forks_count":21,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-08-13T01:25:40.511Z","etag":null,"topics":["ai","docs","documentation","freeswitch","ivr","open-source","signalwire","telephony"],"latest_commit_sha":null,"homepage":"https://developer.signalwire.com","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/signalwire.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-19T19:52:24.000Z","updated_at":"2025-08-12T20:18:17.000Z","dependencies_parsed_at":"2025-08-13T01:29:08.344Z","dependency_job_id":null,"html_url":"https://github.com/signalwire/docs","commit_stats":null,"previous_names":["signalwire/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/signalwire/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalwire%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalwire%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalwire%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalwire%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/signalwire","download_url":"https://codeload.github.com/signalwire/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalwire%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270657491,"owners_count":24623458,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","docs","documentation","freeswitch","ivr","open-source","signalwire","telephony"],"created_at":"2025-08-16T01:40:04.271Z","updated_at":"2025-08-16T01:40:05.248Z","avatar_url":"https://github.com/signalwire.png","language":"MDX","readme":"\u003c!-- Header --\u003e\r\n\u003cdiv align=\"center\"\u003e\r\n    \u003cimg src=\"static/img/logo.svg\" width=\"500\" href=\"https://signalwire.com\" /\u003e\r\n    \u003ch1\u003eSignalWire Docs\u003c/h1\u003e\r\n    \u003ch4\u003e\u003ci\u003eAn open-source docs site built with \u003ca href=\"https://docusaurus.io/\"\u003e🦕 Docusaurus\u003c/a\u003e\u003c/i\u003e\u003c/h4\u003e\r\n\u003c/div\u003e\r\n\u003cp align=\"center\"\u003e\r\n  \u003ca href=\"https://developer.signalwire.com/\" target=\"_blank\"\u003e📖 Explore the docs\u003c/a\u003e •\r\n  \u003ca href=\"https://github.com/signalwire/signalwire-docs/issues/new/choose\" target=\"_blank\"\u003e🐛 Report an issue\u003c/a\u003e •\r\n  \u003ca href=\"https://github.com/signalwire/signalwire-docs/pulls\" target=\"_blank\"\u003e✍️ Contribute\u003c/a\u003e\r\n\u003c/p\u003e\r\n\r\n\u003c!-- Badges --\u003e\r\n\u003cdiv align=\"center\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/Discord%20Community-5865F2\" alt=\"Discord\" href=\"https://discord.com/invite/F2WNYTNjuF\"/\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/MIT-License-blue\" alt=\"MIT License\" href=\"LICENSE\" /\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/Creative%20Commons-license-blue.svg?logo=creativecommons\u0026logoColor=ffffff\"/\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg\" alt=\"Contributor Covenant\" href=\"CODE_OF_CONDUCT.md\"/\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/GitHub-%23121011.svg?logo=github\u0026logoColor=white\u0026\" alt=\"GitHub\" href=\"https://github.com/signalwire\"/\u003e\r\n    \u003cimg src=\"https://img.shields.io/github/stars/signalwire/docs\" alt=\"GitHub Stars\" href=\"https://github.com/signalwire/docs\"/\u003e\r\n\u003c/div\u003e\r\n\r\n\u003cimg src=\"static/img/homepage.png\" alt=\"Homepage\"/\u003e\r\n\r\n\r\n## Contents\r\n\r\n- 💡 [Overview](#-overview)\r\n  - 📚 [Docs Wiki](#-docs-wiki)\r\n  - 🏗️ [Structure](#️-structure)\r\n  - 📄 [License](#-license)\r\n- ✍️ [Contribute](#️-contribute)\r\n  - ☁️ [REST API docs](#️-rest-api-documentation)\r\n- 🚀 [Usage](#-usage)\r\n- 💬 [Contact \u0026 Support](#-contact-and-support)\r\n\r\n## 💡 Overview\r\n\r\n\r\nWelcome to SignalWire's open-source docs repository!\r\n\r\nThis README includes an overview of the project structure, requirements for contributors, and instructions for local development.\r\n\r\n### 📚 Docs Wiki\r\n\r\nThe wiki hosts in-depth references and guides for maintaining, building, configuring, and deploying the docs site.\r\n\r\n- [Configuration files](https://github.com/signalwire/signalwire-docs/wiki/Docusaurus-configuration-files)\r\n- [Plugins](https://github.com/signalwire/signalwire-docs/wiki/Docusaurus-Plugins)\r\n- [Licensing](https://github.com/signalwire/signalwire-docs/wiki/Licensing)\r\n- [Pull Requests and Issues](https://github.com/signalwire/signalwire-docs/wiki/Guide-to-Pull-Requests-and-Issues)\r\n- [REST API specs \u0026 docs](https://github.com/signalwire/signalwire-docs/wiki/REST-API-Specs-\u0026-Docs)\r\n- [Sidebars configuration](https://github.com/signalwire/signalwire-docs/wiki/Sidebars-Configuration)\r\n- [Slugs: best practices](https://github.com/signalwire/signalwire-docs/wiki/Slugs:-Best-practices)\r\n- [Written style guide](https://github.com/signalwire/signalwire-docs/wiki/Written-Style-Guide)\r\n\r\n### 🏗️ Structure\r\n\r\n\r\nThe SignalWire Docs are built with \u003ca href=\"https://docusaurus.io/\"\u003eDocusaurus\u003c/a\u003e.\r\nContents of the SignalWire Docs are organized by the following types:\r\n\r\n- **Guides:** Introductions, quickstarts, examples, and how-to guides. These are written in Markdown/MDX and use the [docs plugin](https://docusaurus.io/docs/docs-introduction).\r\n- **Technical Reference:** API and SDK reference docs. These also use the docs plugin, but in most cases are automatically generated from [TypeSpec](https://typespec.io/) or [OpenAPI](https://swagger.io/specification/) specification files.\r\n- **Pages:** Standalone specialty pages that use the [pages plugin](https://docusaurus.io/docs/creating-pages), like the [Guides Showcase](https://developer.signalwire.com/guides) and unlisted references for UI components.\r\n\r\nConsult the wiki's [Repository guide](https://github.com/signalwire/signalwire-docs/wiki/Repository-guide) for more information.\r\n\r\n### 📜 License\r\n\r\nThe SignalWire Docs are available under the MIT license and Creative Commons **CC BY-NC-SA 4.0** license.\r\n\r\nFor more information, refer to the [Licensing wiki article](https://github.com/signalwire/signalwire-docs/wiki/Licensing).\r\n\r\n---\r\n\r\n## ✍️ Contribute\r\n\r\nSignalWire welcomes contributions to the documentation!\r\nWhether you're fixing a typo, making an issue for missing information, or submitting new content, \r\nyour contributions will improve the experience for everyone in the SignalWire community.\r\n\r\n1. Read [CONTRIBUTING.md](CONTRIBUTING.md), our [Code of Conduct](CODE_OF_CONDUCT.md), and the [SignalWire Privacy Policy](https://m.signalwire.com/policies?doc=privacy).\r\n2. Review our [Guide to Pull Requests and Issues]([prs-issues-guide]), [Style Guide]([style-guide]), and [Pull Request and deploy preview process]([prs-deploy]).\r\n3. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).\r\n4. Follow the [Usage](#usage) instructions to set up the local development environment.\r\n5. Make your changes and [submit a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).\r\n\r\n\u003e [!IMPORTANT]\r\n\u003e Contributions to the API docs require additional workflows.\r\n\u003e Refer to the [API docs guide](https://github.com/signalwire/signalwire-docs/wiki/REST-API-Specs-\u0026-Docs) for in-depth instructions.\r\n\r\n---\r\n\r\n## 🚀 Usage\r\n\r\n1. **Install prerequisites**\r\n\r\n    - [Node.js](https://nodejs.org/en)\r\n\r\n2. **Clone the repo**\r\n\r\n3. **Install dependencies**\r\n\r\n```\r\nnpm install\r\n```\r\n\r\n4. **Start the local development server**\r\n\r\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\r\n\r\n```\r\nnpm run start\r\n```\r\n\r\n5. **Make your changes**\r\n\r\n6. **Build**\r\n\r\nThis command generates static content into the `build` directory.\r\n\r\n```\r\n$ npm run build\r\n```\r\n\r\nThe built site is now ready for deployment!\r\n\r\n### ☁️ REST API documentation\r\n\r\nThe pages related to REST APIs are defined in [TypeSpec](https://typespec.io/docs) which are then compiled into [OpenAPI Spec](https://swagger.io/specification/) files. \r\nThese files live in the [`api`](https://github.com/signalwire/signalwire-docs/tree/main/api) directory.\r\n\r\nRefer to the [REST API Specs \u0026 Docs](https://github.com/signalwire/signalwire-docs/wiki/REST-API-Specs-\u0026-Docs) wiki article for more information.\r\n\r\n---\r\n\r\n## 💬 Contact and Support\r\n\r\nThe SignalWire Docs are maintained by the Developer Experience team.\r\nHave questions or feedback? Email us at devex@signalwire.com.\r\n\r\nContact Support via the [SignalWire Support Portal](https://support.signalwire.com/hc/en-us).\r\n\r\n\u003c!-- Links --\u003e\r\n[prs-issues-guide]: https://github.com/signalwire/signalwire-docs/wiki/Guidelines-to-Pull-Request-and-Issues\r\n[style-guide]: https://github.com/signalwire/signalwire-docs/wiki/Style-Guidelines\r\n[prs-deploy]: https://github.com/signalwire/signalwire-docs/wiki/Contributing-to-the-signalwire%E2%80%90docs-repository","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsignalwire%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsignalwire%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsignalwire%2Fdocs/lists"}