docs(contributing): fix broken local-dev setup steps#506
Open
TerrifiedBug wants to merge 1 commit into
Open
Conversation
The setup guide pointed at a root .env.example that does not exist and listed an ENCRYPTION_KEY variable the app does not read, so a contributor following it verbatim could not boot. - copy the maintained template from docker/server/.env.example - replace ENCRYPTION_KEY with VF_ENCRYPTION_KEY_V2 (optional; derived from NEXTAUTH_SECRET when unset) - bump the pnpm prerequisite to 10.x to match packageManager (pnpm@10.13.1)
github-actions
Bot
added
the
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The Development Setup section was broken for new contributors (found during a DX review — see
review/uxdx__core.md):cp .env.example .env— there is no root.env.example; the maintained template isdocker/server/.env.example.ENCRYPTION_KEY, which the app does not read. The real variable isVF_ENCRYPTION_KEY_V2, and it is optional (derived fromNEXTAUTH_SECRETwhen unset — seesrc/lib/env.ts).9.x, butpackageManagerpinspnpm@10.13.1.A new contributor following the guide verbatim could not boot the app.
Change
Docs-only. Points the env step at
docker/server/.env.example, corrects the encryption-key variable name and its optionality, and bumps the pnpm prerequisite to10.x. Node stays at22.xto match CI.No code touched — tests/build unaffected. Verified
docker/server/.env.exampleexists andVF_ENCRYPTION_KEY_V2is the variable read bysrc/lib/env.ts.