Skip to content

Commit b101c6d

Browse files
lucasmelloslucasmellos
committed
initial commit
0 parents  commit b101c6d

File tree

2,342 files changed

+343631
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,342 files changed

+343631
-0
lines changed

‎.dockerignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.docusaurus
2+
3+
/build
4+
/node_modules
5+
/sites/*/build
6+
/sites/*/node_modules

‎.editorconfig

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
root = true
2+
3+
[*]
4+
max_line_length = 90

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Devon-White @briankwest @niravcodes @hey-august

‎.github/ISSUE_TEMPLATE/404.yaml

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: 404
2+
description: Report a broken link on a SignalWire documentation site.
3+
title: "[404] - "
4+
labels: ["team/developer-experience", "type/chore", "status/needs-triage"]
5+
assignees:
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for helping us keep our documentation up to date!
11+
> [!CAUTION]
12+
> 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.
13+
- type: input
14+
id: broken-link
15+
attributes:
16+
label: Broken link
17+
description: Paste the full broken link here.
18+
placeholder: https://developer.signalwire.com/broken/link
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: where-found
23+
attributes:
24+
label: Link location
25+
description: Where did you find this link?
26+
placeholder: Google search, docs site, customer, etc.
27+
value:
28+
validations:
29+
required: true
30+
- type: input
31+
id: correct-link
32+
attributes:
33+
label: Correct link
34+
description: What's the correct link?
35+
placeholder: https://developer.signalwire.com/correct/link
36+
validations:
37+
required: false
38+
- type: input
39+
id: other-info
40+
attributes:
41+
label: Other info
42+
description: Any additional context
43+
validations:
44+
required: false
45+
- type: markdown
46+
attributes:
47+
value: |
48+
Thank you!

‎.github/ISSUE_TEMPLATE/404.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: '404'
2+
description: Report a broken link on a SignalWire documentation site.
3+
title: "[404] - "
4+
labels: ["team/developer-experience", "type/chore", "status/needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping us keep our documentation up to date!
10+
> [!CAUTION]
11+
> 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.
12+
- type: input
13+
id: broken-link
14+
attributes:
15+
label: Broken link
16+
description: Paste the full broken link here.
17+
placeholder: https://developer.signalwire.com/broken/link
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: where-found
22+
attributes:
23+
label: Link location
24+
description: |
25+
Where did you find this link?
26+
Be sure to include a case number if the link was discovered in a support ticket.
27+
placeholder: Google search, docs site, customer, etc.
28+
value:
29+
validations:
30+
required: true
31+
- type: input
32+
id: correct-link
33+
attributes:
34+
label: Correct link
35+
description: What's the correct link?
36+
placeholder: https://developer.signalwire.com/correct/link
37+
validations:
38+
required: false
39+
- type: textarea
40+
id: other-info
41+
attributes:
42+
label: Other info
43+
description: Any additional context
44+
validations:
45+
required: false
46+
- type: markdown
47+
attributes:
48+
value: |
49+
Thanks for catching that!

‎.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Report bugs about our documentation site.
4+
title: "[BUG] - "
5+
labels: team/developer-experience, status/needs-triage
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/documentation-requests.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Documentation Requests
3+
about: Request updates, additions, or corrections to the documentation
4+
title: "[DOC] - "
5+
labels: area/documentation, team/developer-experience, status/needs-triage
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the requested update**
11+
Provide a clear and concise description of what needs to be updated or added to the documentation.
12+
13+
**Reason for the request**
14+
Explain why this update is necessary. Is there missing information, outdated content, or an error that needs correction?
15+
16+
**Sections to be updated**
17+
List the specific sections or pages of the documentation that should be updated or added.
18+
19+
**Additional context**
20+
Add any other context or screenshots that might help understand the request.
21+
22+
**Related Issues or PRs**
23+
If this request is related to any existing issues or pull requests, please link them here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Feature request
3+
about: Request a feature to add to our documentation. A feature request should not
4+
be used for documentation suggestions.
5+
title: "[FEATURE REQUEST] - "
6+
labels: team/developer-experience, type/feature-request, status/needs-triage
7+
assignees: ''
8+
9+
---
10+
11+
**Is your feature request related to a problem? Please describe.**
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
**Describe the solution you'd like**
15+
A clear and concise description of what you want to happen.
16+
17+
**Describe alternatives you've considered**
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
**Additional context**
21+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/swml_update.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: SWML Update Request
3+
about: Request that documentation and SWML schema are updated with the latest SWML changes.
4+
title: "[SWML Update] - "
5+
labels: team/developer-experience, area/documentation, status/needs-triage
6+
assignees: ''
7+
---
8+
9+
## Type Of Change
10+
11+
- [ ] New SWML Method
12+
- [ ] Update to existing SWML Method
13+
14+
## Are These Changes Already In Production?
15+
16+
- [ ] Yes
17+
- [ ] No
18+
19+
## Description
20+
[Provide a detailed description of the changes]
21+
22+
- **Method(s) Added/Updated:**
23+
- Description of what was Added/Updated on the Method(s)
24+
- If this is a **New Method**,
25+
- Provide a description of its purpose and functionality.
26+
- Provide what valid types it takes.
27+
- **Method Field(s) Added/Updated:**
28+
- Description of what Field was changed
29+
- If this is a **New Field**
30+
- Provide a description of its purpose and functionality.
31+
- Provide what valid types it takes.
32+
33+
34+
## Context and Motivation
35+
[Explain the context and the motivation behind these changes]
36+
37+
### SWML Example (Optional)
38+
```json
39+
{
40+
"version": "1.0.0",
41+
"sections": {
42+
"main": []
43+
}
44+
}

‎.github/PULL_REQUEST_TEMPLATE/other.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Other Changes Pull Request
2+
3+
## Description
4+
5+
Please include a summary of the changes and the related issue. Specify what type of change this is.
6+
7+
## Related Issue
8+
9+
Link to the issue here: [Issue #](
10+
11+
## Type of Change
12+
13+
- [ ] Docusaurus update/maintenance
14+
- [ ] Dependency update
15+
- [ ] Configuration change
16+
- [ ] Plugin update
17+
- [ ] Bug fix
18+
- [ ] Style Change
19+
- [ ] Performance improvement
20+
- [ ] Refactoring
21+
- [ ] Build process update
22+
- [ ] Other (please specify):
23+
24+
<!-- If you selected "Docusaurus update/maintenance", please fill out the following section -->
25+
### Docusaurus Update/Maintenance Details
26+
- **Dependency Update**: Name and version of the updated dependency
27+
- **Configuration Changed**: Describe the configuration changes made
28+
- **Plugin Update**: Name and version of the updated plugin
29+
- **Bug Fix**: Describe the bug that was fixed and the solution
30+
- **Style Change**: Describe the style changes implemented
31+
32+
### Other Change Details (if applicable)
33+
- **Description**: Provide a detailed description of the change
34+
35+
## Motivation and Context
36+
37+
Why is this change required? What problem does it solve?
38+
39+
## Checklist:
40+
41+
- [ ] My changes follow the [style guidelines](https://github.com/signalwire/signalwire-docs/wiki/Style-Guidelines) of this project
42+
- [ ] I have performed a self-review of my changes
43+
- [ ] My changes generate no new warnings
44+
- [ ] Builds successfully locally
45+
46+
## Additional Notes
47+
48+
Add any other context about the pull request here.

‎.github/PULL_REQUEST_TEMPLATE/rest_api_update.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# REST API Update Pull Request
2+
3+
## Related Issue
4+
5+
If there's an issue available, link it here: [Issue #](
6+
7+
## Description
8+
9+
Please include a summary of the changes and the related issue. List any new dependencies required for this change.
10+
11+
## Type of Change
12+
13+
- [ ] New endpoint
14+
- [ ] Update to existing endpoint
15+
16+
## Motivation and Context
17+
18+
Why is this change required? What problem does it solve?
19+
20+
## Checklist:
21+
22+
- [ ] I have read and fully understand the [process for updating the REST API](https://github.com/signalwire/signalwire-docs/wiki/REST-API-Specs-&-Docs)
23+
- [ ] [Mandatory fields](https://github.com/signalwire/signalwire-docs/wiki/REST-API-Specs-&-Docs#documentation-required-decorators) are present in the TypeSpec files.
24+
- [ ] TypeSpec files successfully compiled OpenAPI spec files.
25+
- [ ] No new warnings were generated during the compilation process.
26+
- [ ] OpenAPI spec files were validated with a SWAGGER UI tool to ensure they are correct.
27+
- [ ] The DevEx team has been alerted with the new changed by including the `team/developer-experience` label in the PR.
28+
29+
30+
31+
## Additional Notes
32+
33+
Add any other context about the pull request here.

‎.github/PULL_REQUEST_TEMPLATE/updating_docs.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Documentation Update Pull Request
2+
3+
## Description
4+
5+
Please include a summary of the changes and the related issue. Specify the sections of the documentation that have been updated.
6+
7+
<!-- Delete the `Related Issue` section if there is no related issue open with this Pull Request -->
8+
## Related Issue
9+
10+
If there's an issue available, link it here: [Issue #](
11+
12+
## Type of Change
13+
14+
- [ ] New documentation
15+
- [ ] Update to existing documentation
16+
17+
### Documentation Change Details
18+
- **Changes Summary**: Brief summary of the changes
19+
20+
## Motivation and Context
21+
22+
Why is this change required? What problem does it solve?
23+
24+
## Checklist:
25+
26+
- [ ] My documentation follows the [style guidelines](https://github.com/signalwire/signalwire-docs/wiki/Style-Guidelines) of this project
27+
- [ ] I have performed a self-review of my documentation
28+
- [ ] My changes generate no new warnings
29+
- [ ] Builds successfully locally
30+
31+
## Additional Notes
32+
33+
Add any other context about the documentation update here.

‎.github/pull_request_template.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
**PLEASE READ BELOW**
2+
3+
Please click on the `Preview` tab and then select the appropriate template for your pull request.
4+
If you do not see a template that fits your pull request, select the `Other Changes` template.
5+
6+
- [Documentation Update & Changes](?labels=area/documentation&expand=1&template=updating_docs.md)
7+
- [REST API Update](?labels=area/rest-api&expand=1&template=rest_api_update.md)
8+
- [Other Changes](?labels=area/general&expand=1&template=other.md)

‎.github/wip.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
- terms:
2+
- wip
3+
- work in progress
4+
- 🚧
5+
locations: title
6+
- terms: status/waiting-for-release
7+
locations: label_name

0 commit comments

Comments
 (0)