docs(deployment): remove duplicate Development/Testing/Troubleshooting sections from DEPLOYMENT.md#219
Open
andrerfneves wants to merge 1 commit into
Open
Conversation
…rom DEPLOYMENT.md The Development, Testing, and Troubleshooting sections in DEPLOYMENT.md duplicated content already present in README.md, creating documentation drift risk. Removed these sections and added a cross-reference to the README for development, testing, and troubleshooting instructions. Kept the Build for Production section since it's directly relevant to deployment workflows.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
Removes duplicate Development, Testing, and Troubleshooting sections from
DEPLOYMENT.mdthat overlapped with content already inREADME.md. Adds a cross-reference to the README for dev/test/troubleshooting instructions. Keeps the Build for Production section since it's directly relevant to deployment workflows.Why
Having the same information in two files creates documentation drift risk — when someone updates the build command, test command, or Node.js version requirement in the README, they'd need to remember to also update
DEPLOYMENT.md. Removing these duplicate sections eliminates the drift surface while keeping deployment-relevant content.Sections removed
npm install,npm run dev,npm run storybook— all already documented in the READMEnpm testwith Vitest — already documented in the READMESections retained
npm run buildand build output explanation — kept because building is a prerequisite for deploymentChanges
DEPLOYMENT.md: Removed 3 duplicate sections (57 lines), added cross-reference to READMETest Plan