From 96044c51e3c318a263e10adb3945981d924a2585 Mon Sep 17 00:00:00 2001 From: yasnazariel <82168644+yasnazariel@users.noreply.github.com> Date: Fri, 21 Nov 2025 19:51:57 +0330 Subject: [PATCH] Clarify API key requirement for docs updates This PR adds a short clarification to the README about when a Talent Protocol API key is actually required. - Makes it clear that contributors editing only non-autogenerated `.mdx` docs can run `npm run start` without needing an API key. - Aims to reduce friction for first-time contributors who just want to fix or add simple documentation. --- README.md | 2 ++ 1 file changed, 2 insertions(+) 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