chore: update docs for json schema (#250)

docs/local-sdk-development.md

@@ -3,3 +3,7 @@
 When developing the SDK locally, you can enable the SDK to rebuild "on save" by running `npm run dev`.
 
 We recommend testing changes to the SDK against the SDK-Playground example, which can be found [here](https://github.com/discord/embedded-app-sdk-examples/tree/main/sdk-playground#testing-sdk-changes-locally).
+
+## JSON Schema updates
+
+If you need to update any generated JSON schema values, follow the guide [here](/docs/schema-gen.md).

docs/schema-gen.md

@@ -0,0 +1,8 @@
+Some of the RPC commands and Typescript Types are constructed via a JSON schema which is generated by Discord. To update the JSON schema, please do the following:
+
+- From Discord, make sure you have run `clyde gen rpc`
+- From the root of this github repo, run the following
+  ```
+  npm run sync -- --path path/to/monorepo/discord_common/js/packages/rpc-schema/generated/schema.json
+  ```
+- Commit your changes and update as needed

scripts/syncRPCSchema.mjs

@@ -9,7 +9,7 @@ const defaultBranch = 'main';
 const branch = argv.branch ?? defaultBranch;
 let jsonSchemaPath = argv.path;
 if (jsonSchemaPath == null) {
-  throw new Error('Expected --path argument.\nThis should point to the generated JSON Schema.');
+  throw new Error('Expected -- --path argument.\nThis should point to the generated JSON Schema file.\nExample command below:\nnpm run sync -- --path path/to/monorepo/discord_common/js/packages/rpc-schema/generated/schema.json');
 }
 // Resolve absolute path
 jsonSchemaPath = path.resolve(jsonSchemaPath);