diff --git a/docs/contribute/contribute.md b/docs/contribute/contribute.md index a331c3e6..05c24864 100644 --- a/docs/contribute/contribute.md +++ b/docs/contribute/contribute.md @@ -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 ``` diff --git a/docs/contribute/create_sample.md b/docs/contribute/create_sample.md index ee9506f2..cd85452d 100644 --- a/docs/contribute/create_sample.md +++ b/docs/contribute/create_sample.md @@ -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 {