diff --git a/README.md b/README.md index 38b641c..dedba7b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ ## How to Update Docs +If you're only editing non-autogenerated `.mdx` docs and not running any data point or API generation scripts, you can work locally without a Talent Protocol API key and just preview your changes with `npm run start`. + You'll need to have a `.env` file with a `TALENT_PROTOCOL_API_KEY` as access to the Talent Protocol API is required to auto-generate some of the documentation. Any working key will work, you can grab one from our [developer page](https://app.talentprotocol.com/developers). ### Data Points