Skip to content

Clarify API key requirement for docs updates #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yasnazariel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify API key requirement for docs updates #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down