Skip to content
Devon edited this page Dec 30, 2024 · 1 revision

☎️ About

Welcome! This wiki hosts the documentation for the SignalWire Docs repository.

🤝 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.

Note

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

💡 Learn

Quick start reference for editing and adding to the main docs repository using GitHub Pull Requests (PRs).

Refer here for stylistic standards and best practices for writing docs, including:

  • Glossary
  • Written Style
  • Docusaurus Formatting
  • HTML & CSS
  • Syntax
  • Automated Formatting

🌐 Edit this Wiki

SignalWire staff who are Contributors to the repository can edit the Wiki directly. If you change a page title, its slug will change, and links from this Home page will need to be updated as well. Suggest changes to the Wiki by filing an issue.