-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b101c6d
Showing
2,342 changed files
with
343,631 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.docusaurus | ||
|
||
/build | ||
/node_modules | ||
/sites/*/build | ||
/sites/*/node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
root = true | ||
|
||
[*] | ||
max_line_length = 90 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @Devon-White @briankwest @niravcodes @hey-august |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
name: 404 | ||
description: Report a broken link on a SignalWire documentation site. | ||
title: "[404] - " | ||
labels: ["team/developer-experience", "type/chore", "status/needs-triage"] | ||
assignees: | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for helping us keep our documentation up to date! | ||
> [!CAUTION] | ||
> Authors should avoid change slugs (URLs) of docs whenever possible, and closely follow the instructions in the [wiki article on slugs](https://github.com/signalwire/signalwire-docs/wiki/Slug:-Best-practices#never-change-slugs) when a change is unavoidable. | ||
- type: input | ||
id: broken-link | ||
attributes: | ||
label: Broken link | ||
description: Paste the full broken link here. | ||
placeholder: https://developer.signalwire.com/broken/link | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: where-found | ||
attributes: | ||
label: Link location | ||
description: Where did you find this link? | ||
placeholder: Google search, docs site, customer, etc. | ||
value: | ||
validations: | ||
required: true | ||
- type: input | ||
id: correct-link | ||
attributes: | ||
label: Correct link | ||
description: What's the correct link? | ||
placeholder: https://developer.signalwire.com/correct/link | ||
validations: | ||
required: false | ||
- type: input | ||
id: other-info | ||
attributes: | ||
label: Other info | ||
description: Any additional context | ||
validations: | ||
required: false | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
name: '404' | ||
description: Report a broken link on a SignalWire documentation site. | ||
title: "[404] - " | ||
labels: ["team/developer-experience", "type/chore", "status/needs-triage"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for helping us keep our documentation up to date! | ||
> [!CAUTION] | ||
> Authors should avoid changing slugs (URLs) of docs whenever possible, and closely follow the instructions in the [wiki article on slugs](https://github.com/signalwire/signalwire-docs/wiki/Slug:-Best-practices#never-change-slugs) when a change is unavoidable. | ||
- type: input | ||
id: broken-link | ||
attributes: | ||
label: Broken link | ||
description: Paste the full broken link here. | ||
placeholder: https://developer.signalwire.com/broken/link | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: where-found | ||
attributes: | ||
label: Link location | ||
description: | | ||
Where did you find this link? | ||
Be sure to include a case number if the link was discovered in a support ticket. | ||
placeholder: Google search, docs site, customer, etc. | ||
value: | ||
validations: | ||
required: true | ||
- type: input | ||
id: correct-link | ||
attributes: | ||
label: Correct link | ||
description: What's the correct link? | ||
placeholder: https://developer.signalwire.com/correct/link | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: other-info | ||
attributes: | ||
label: Other info | ||
description: Any additional context | ||
validations: | ||
required: false | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for catching that! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
name: Bug report | ||
about: Report bugs about our documentation site. | ||
title: "[BUG] - " | ||
labels: team/developer-experience, status/needs-triage | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Documentation Requests | ||
about: Request updates, additions, or corrections to the documentation | ||
title: "[DOC] - " | ||
labels: area/documentation, team/developer-experience, status/needs-triage | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the requested update** | ||
Provide a clear and concise description of what needs to be updated or added to the documentation. | ||
|
||
**Reason for the request** | ||
Explain why this update is necessary. Is there missing information, outdated content, or an error that needs correction? | ||
|
||
**Sections to be updated** | ||
List the specific sections or pages of the documentation that should be updated or added. | ||
|
||
**Additional context** | ||
Add any other context or screenshots that might help understand the request. | ||
|
||
**Related Issues or PRs** | ||
If this request is related to any existing issues or pull requests, please link them here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
name: Feature request | ||
about: Request a feature to add to our documentation. A feature request should not | ||
be used for documentation suggestions. | ||
title: "[FEATURE REQUEST] - " | ||
labels: team/developer-experience, type/feature-request, status/needs-triage | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
name: SWML Update Request | ||
about: Request that documentation and SWML schema are updated with the latest SWML changes. | ||
title: "[SWML Update] - " | ||
labels: team/developer-experience, area/documentation, status/needs-triage | ||
assignees: '' | ||
--- | ||
|
||
## Type Of Change | ||
|
||
- [ ] New SWML Method | ||
- [ ] Update to existing SWML Method | ||
|
||
## Are These Changes Already In Production? | ||
|
||
- [ ] Yes | ||
- [ ] No | ||
|
||
## Description | ||
[Provide a detailed description of the changes] | ||
|
||
- **Method(s) Added/Updated:** | ||
- Description of what was Added/Updated on the Method(s) | ||
- If this is a **New Method**, | ||
- Provide a description of its purpose and functionality. | ||
- Provide what valid types it takes. | ||
- **Method Field(s) Added/Updated:** | ||
- Description of what Field was changed | ||
- If this is a **New Field** | ||
- Provide a description of its purpose and functionality. | ||
- Provide what valid types it takes. | ||
|
||
|
||
## Context and Motivation | ||
[Explain the context and the motivation behind these changes] | ||
|
||
### SWML Example (Optional) | ||
```json | ||
{ | ||
"version": "1.0.0", | ||
"sections": { | ||
"main": [] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Other Changes Pull Request | ||
|
||
## Description | ||
|
||
Please include a summary of the changes and the related issue. Specify what type of change this is. | ||
|
||
## Related Issue | ||
|
||
Link to the issue here: [Issue #]( | ||
|
||
## Type of Change | ||
|
||
- [ ] Docusaurus update/maintenance | ||
- [ ] Dependency update | ||
- [ ] Configuration change | ||
- [ ] Plugin update | ||
- [ ] Bug fix | ||
- [ ] Style Change | ||
- [ ] Performance improvement | ||
- [ ] Refactoring | ||
- [ ] Build process update | ||
- [ ] Other (please specify): | ||
|
||
<!-- If you selected "Docusaurus update/maintenance", please fill out the following section --> | ||
### Docusaurus Update/Maintenance Details | ||
- **Dependency Update**: Name and version of the updated dependency | ||
- **Configuration Changed**: Describe the configuration changes made | ||
- **Plugin Update**: Name and version of the updated plugin | ||
- **Bug Fix**: Describe the bug that was fixed and the solution | ||
- **Style Change**: Describe the style changes implemented | ||
|
||
### Other Change Details (if applicable) | ||
- **Description**: Provide a detailed description of the change | ||
|
||
## Motivation and Context | ||
|
||
Why is this change required? What problem does it solve? | ||
|
||
## Checklist: | ||
|
||
- [ ] My changes follow the [style guidelines](https://github.com/signalwire/signalwire-docs/wiki/Style-Guidelines) of this project | ||
- [ ] I have performed a self-review of my changes | ||
- [ ] My changes generate no new warnings | ||
- [ ] Builds successfully locally | ||
|
||
## Additional Notes | ||
|
||
Add any other context about the pull request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# REST API Update Pull Request | ||
|
||
## Related Issue | ||
|
||
If there's an issue available, link it here: [Issue #]( | ||
|
||
## Description | ||
|
||
Please include a summary of the changes and the related issue. List any new dependencies required for this change. | ||
|
||
## Type of Change | ||
|
||
- [ ] New endpoint | ||
- [ ] Update to existing endpoint | ||
|
||
## Motivation and Context | ||
|
||
Why is this change required? What problem does it solve? | ||
|
||
## Checklist: | ||
|
||
- [ ] I have read and fully understand the [process for updating the REST API](https://github.com/signalwire/signalwire-docs/wiki/REST-API-Specs-&-Docs) | ||
- [ ] [Mandatory fields](https://github.com/signalwire/signalwire-docs/wiki/REST-API-Specs-&-Docs#documentation-required-decorators) are present in the TypeSpec files. | ||
- [ ] TypeSpec files successfully compiled OpenAPI spec files. | ||
- [ ] No new warnings were generated during the compilation process. | ||
- [ ] OpenAPI spec files were validated with a SWAGGER UI tool to ensure they are correct. | ||
- [ ] The DevEx team has been alerted with the new changed by including the `team/developer-experience` label in the PR. | ||
|
||
|
||
|
||
## Additional Notes | ||
|
||
Add any other context about the pull request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Documentation Update Pull Request | ||
|
||
## Description | ||
|
||
Please include a summary of the changes and the related issue. Specify the sections of the documentation that have been updated. | ||
|
||
<!-- Delete the `Related Issue` section if there is no related issue open with this Pull Request --> | ||
## Related Issue | ||
|
||
If there's an issue available, link it here: [Issue #]( | ||
|
||
## Type of Change | ||
|
||
- [ ] New documentation | ||
- [ ] Update to existing documentation | ||
|
||
### Documentation Change Details | ||
- **Changes Summary**: Brief summary of the changes | ||
|
||
## Motivation and Context | ||
|
||
Why is this change required? What problem does it solve? | ||
|
||
## Checklist: | ||
|
||
- [ ] My documentation follows the [style guidelines](https://github.com/signalwire/signalwire-docs/wiki/Style-Guidelines) of this project | ||
- [ ] I have performed a self-review of my documentation | ||
- [ ] My changes generate no new warnings | ||
- [ ] Builds successfully locally | ||
|
||
## Additional Notes | ||
|
||
Add any other context about the documentation update here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
**PLEASE READ BELOW** | ||
|
||
Please click on the `Preview` tab and then select the appropriate template for your pull request. | ||
If you do not see a template that fits your pull request, select the `Other Changes` template. | ||
|
||
- [Documentation Update & Changes](?labels=area/documentation&expand=1&template=updating_docs.md) | ||
- [REST API Update](?labels=area/rest-api&expand=1&template=rest_api_update.md) | ||
- [Other Changes](?labels=area/general&expand=1&template=other.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
- terms: | ||
- wip | ||
- work in progress | ||
- 🚧 | ||
locations: title | ||
- terms: status/waiting-for-release | ||
locations: label_name |
Oops, something went wrong.