Licensing

License

The source for the SignalWire Docs website ("the site", "the docs") is available in this repository. In addition to viewing the source, anybody can raise issues, contribute by opening pull requests, and and in limited circumstances (or with special permission) reuse and redistribute the docs.

Code: The source code in this repository is open source under the MIT license.

• Source code includes our Docusaurus implementation and configuration, as well as all first-party, custom, and third-party plugins.

Content: The Creative Commons CC BY-NC-SA 4.0 license applies to all content in this repository.

• Content includes text content (including code samples) and images.
• The content license prohibits commercial use, and requires attribution and the use of the same license for reuse.

Redistribution

Bring-your-own components

Redistributed versions of the SignalWire Docs will need to bring their own solutions for the following:

• 🎨 Branding: Logo images, color schemes, and other branding elements are configured in the static/img directory.
• 🔍 Search: The SignalWire Docs site uses Typesense for search. We recommend Typesense or Algolia, both of which offer free tiers and hosted solutions.
• 📊 Analytics: The site is configured to use Google Analytics. You will need to configure the .env file with your Google Analytics credentials.
• 🏗️ Deploy previews: The site is configured to use Netlify for automatic deploy previews on Pull Requests.
• 🔄 Continuous Integration: The site is configured to use GitHub Actions for continuous integration and deployment.

Additional considerations

• Redirects: Redirects are configured in the nginx redirects.map file. When adding content to your fork, avoid using existing slugs to prevent conflicts.