Conversation
Co-authored-by: GizzZmo <8039975+GizzZmo@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation and README for clarity
Update README and contributing docs for current setup and validation flow
Dec 28, 2025
GizzZmo
approved these changes
Dec 28, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the README and CONTRIBUTING documentation to reflect the current Node.js requirements, streamlined installation process, and mandatory build order for the Master Prompt Editor monorepo. The changes clarify prerequisites (Node.js 20.x/npm 10.x), consolidate installation to a single command (npm run install:all), document the required shared types build step before server compilation, explain Vite-specific environment variable usage, and add a comprehensive validation checklist for manual smoke testing.
Key Changes
- Updated prerequisites to specify Node.js 20.x and npm 10.x (matching CI requirements)
- Streamlined installation from multiple commands to single
npm run install:allcommand - Added critical documentation for
npx tsc --build src/typesrequirement before server builds - Introduced new "Environment Variables" and "Validation Checklist" sections in README
- Aligned CONTRIBUTING.md with README build requirements
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updated prerequisites (Node.js 20.x/npm 10.x), consolidated installation steps, added environment variables section explaining Vite's import.meta.env, documented required shared types build step, and added comprehensive validation checklist with backend health check and frontend navigation smoke tests |
| CONTRIBUTING.md | Added Node.js 20.x requirement and referenced shared types build step to align with README and CI configuration |
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
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.
The documentation needed to reflect the current Node/npm requirements, streamlined install/build steps, and the required shared-type build step for server compilation.
Prerequisites & install
npm run install:allas the single install entrypoint.Build & validation
npx tsc --build src/typesbefore server builds.npm run build:alland add a concise validation checklist (types build, full build, lint, backend health check, frontend navigation + Ctrl+/ shortcut).Environment variables
import.meta.env(e.g.,import.meta.env.VITE_API_URL).Contributing
Example snippet:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.