Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/contribute/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ First you'll need a installation of nodecg-io. Please refer to the [installation
instead of using our repository you might want to fork the nodecg-io repository to your GitHub account and clone your fork.

To make changes to the documentation you also need to clone the docs repo:

```shell
git clone https://github.com/codeoverflow-org/nodecg-io-docs.git
```
Expand Down
5 changes: 4 additions & 1 deletion docs/contribute/create_sample.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Create a sample bundle

Create a folder in `samples` and add a `package.json` and a `tsconfig.json`:
A sample should have the same name as the service but it may include a short description in the name after the service name aswell.
E.g. `twitch-chat` or `obs-scenelist`.

Create a folder in `samples` named after the sample and add a `package.json` and a `tsconfig.json`:

```json
{
Expand Down