Skip to content

Latest commit

 

History

History
145 lines (100 loc) · 6.84 KB

README.md

File metadata and controls

145 lines (100 loc) · 6.84 KB
Raw

SignalWire Docs

An open-source docs site built with 🦕 Docusaurus

📖 Explore the docs • 🐛 Report an issue • ✍️ Contribute

Slack GitHub MIT License Contributor Covenant GitHub Stars

Homepage

Contents

💡 Overview

Welcome to SignalWire's open-source docs repository!

This README includes an overview of the project structure, requirements for contributors, and instructions for local development.

📚 Docs Wiki

The wiki hosts in-depth references and guides for maintaining, building, configuring, and deploying the docs site.

🏗️ Structure

The SignalWire Docs are built with Docusaurus. Contents of the SignalWire Docs are organized by the following types:

  • Guides: Introductions, quickstarts, examples, and how-to guides. These are written in Markdown/MDX and use the docs plugin.
  • Technical Reference: API and SDK reference docs. These also use the docs plugin, but in most cases are automatically generated from TypeSpec or OpenAPI specification files.
  • Pages: Standalone specialty pages that use the pages plugin, like the Guides Showcase and unlisted references for UI components.

Consult the wiki's Repository guide for more information.

📜 License

The SignalWire Docs are available under the MIT license and Creative Commons CC BY-NC-SA 4.0 license.

For more information, refer to the Licensing wiki article.

✍️ Contribute

SignalWire welcomes contributions to the documentation! Whether you're fixing a typo, making an issue for missing information, or submitting new content, your contributions will improve the experience for everyone in the SignalWire community.

  1. Read CONTRIBUTING.md, our Code of Conduct, and the SignalWire Privacy Policy.
  2. Review our Guide to Pull Requests and Issues, Style Guide, and Pull Request and deploy preview process.
  3. Fork the repository.
  4. Follow the Usage instructions to set up the local development environment.
  5. Make your changes and submit a pull request.

Important

Contributions to the API docs require additional workflows. Refer to the API docs guide for in-depth instructions.

🚀 Usage

  1. Install prerequisites

  2. Clone the repo

  3. Install dependencies

npm install
  1. Start the local development server

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

npm run start

  1. Make your changes

  2. Build

This command generates static content into the build directory.

$ npm run build

The built site is now ready for deployment!

☁️ REST API documentation

The pages related to REST APIs are defined in TypeSpec which are then compiled into OpenAPI Spec files. These files live in the api directory.

Refer to the REST API Specs & Docs wiki article for more information.

💬 Contact and Support

The SignalWire Docs are maintained by the Developer Experience team. Have questions or feedback? Email us at [email protected].

Contact Support via the SignalWire Support Portal.