Skip to content

Commit

Permalink
šŸ›Cannot play test sound in sounds guide (#131)
Browse files Browse the repository at this point in the history
* Start work for issue #121

* ci: adjust spacing for steps

* fix: fix issue with sound in sounds guide

* docs: improve note block

* docs: create new issue template for guide and api changes in a single issue

* docs: remove docs for velaptor version v1.0.0-preview.25
  • Loading branch information
CalvinWilkinson authored Nov 6, 2023
1 parent e76b6fe commit 4925a97
Show file tree
Hide file tree
Showing 144 changed files with 74 additions and 17,424 deletions.
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/api-changes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ body:
| Medium Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/medium%20priority |
| High Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/high%20priority |
> **Note** Removing a version of the API docs can be done by executing the _**Delete API Docs**_ VSCode task.
> **Note**
> Removing a version of the API docs can be done by executing the _**Delete API Docs**_ VSCode task.
> Just follow the CLI instructions to remove the version.
- type: checkboxes
Expand Down
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/guide-api-changes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: šŸ“œ/šŸ›”ļø Guide & API Documentation Changes
description: Create an issue to add or update the API documentation.
title: "šŸ“œ/šŸ›”ļøGuide & API Doc Change - "
labels: ['šŸ“œtutorial doc changes', 'šŸ›”ļøapi doc changes', 'high priority']
projects: ["KinsonDigital/11"]
body:
- type: checkboxes
attributes:
label: Complete The Item Below
options:
- label: I have added the version to the very end of the issue title.
required: true
- label: I have updated the title without removing the šŸ›”ļø and šŸ“œ emoji.
required: true

- type: textarea
attributes:
label: Acceptance Criteria
placeholder: |
Example:
- [ ] If adding a new version of the API documentation, I have locally executed the documentation processing scripts to generate new API documentation.
- [ ] If adding a new version of the API documentation, I have used the correct [Velaptor version](https://github.com/KinsonDigital/Velaptor/tags).
- [ ] Any documentation changes have been checked for proper spelling and grammar.
description: The items to complete in order to satisfy the Definition of Done.
validations:
required: true
render: markdown

- type: checkboxes
attributes:
label: ToDo Items
description: Complete the following items before requesting a PR review.
options:
- label: Change type labels added to this issue. Refer to the _**Change Type Labels**_ section below.
- label: Priority label added to this issue. Refer to the _**Priority Type Labels**_ section below.
- label: If more than 5 versions exist after adding the new version, the oldest version is removed.

- type: textarea
attributes:
label: "Additional Information:"
description: DO NOT CHANGE ANYTHING BELOW!!
value: |
**Priority Type Labels**
| Priority Type | Label |
|---------------------|------------------------------------------------------------------------|
| Low Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/low%20priority |
| Medium Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/medium%20priority |
| High Priority | https://github.com/KinsonDigital/VelaptorDocs/labels/high%20priority |
> **Note**
> Removing a version of the API docs can be done by executing the _**Delete API Docs**_ VSCode task.
> Just follow the CLI instructions to remove the version.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/KinsonDigital/.github/blob/master/docs/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct.
required: true
4 changes: 2 additions & 2 deletions .github/workflows/api-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
needs: validate_branch
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
- name: Checkout Repo
uses: actions/checkout@v4

- name: Validate Syntax
Expand Down Expand Up @@ -73,7 +73,7 @@ jobs:
group: "pages"
cancel-in-progress: true
steps:
- name: Checkout Repo
- name: Checkout Repo
uses: actions/checkout@v4
with:
token: ${{ secrets.CICD_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/prod-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
group: "pages"
cancel-in-progress: true
steps:
- name: Checkout Repo
- name: Checkout Repo
uses: actions/checkout@v4
with:
token: ${{ secrets.CICD_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update-get-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
outputs:
version: ${{ steps.apply_version_to_site.outputs.version }}
steps:
- name: Checkout Repository
- name: Checkout Repository
uses: actions/checkout@v4

- name: Setup Deno
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/guides/sounds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ You can provide whatever audio file you want, but if you don't have one, you can
sound [here](https://github.com/KinsonDigital/VelaptorTutorials/raw/master/Sounds/Content/Sounds/deep-consistency.ogg).

Play it to see if you like it. šŸ˜€
<Audio soundUrl="https://github.com/KinsonDigital/VelaptorTutorials/raw/feature/add-sound-guide/Sounds/Content/Sounds/deep-consistency.ogg"/>
<Audio soundUrl="https://github.com/KinsonDigital/VelaptorTutorials/raw/master/Sounds/Content/Sounds/deep-consistency.ogg"/>

### <span class="color-sub-step">Step 4.2: Setup file as content</span>

Expand Down
27 changes: 0 additions & 27 deletions versioned_docs/version-1.0.0-preview.25/api/Namespaces.md

This file was deleted.

59 changes: 0 additions & 59 deletions versioned_docs/version-1.0.0-preview.25/api/Velaptor.AppStats.md

This file was deleted.

This file was deleted.

11 changes: 0 additions & 11 deletions versioned_docs/version-1.0.0-preview.25/api/Velaptor.Batching.md

This file was deleted.

Loading

0 comments on commit 4925a97

Please sign in to comment.