Skip to content

docs: add tech stack and dev/build/deploy instructions to README#59

Draft
sheenyg with Copilot wants to merge 2 commits into
mainfrom
copilot/update-readme-sections
Draft

docs: add tech stack and dev/build/deploy instructions to README#59
sheenyg with Copilot wants to merge 2 commits into
mainfrom
copilot/update-readme-sections

Conversation

Copilot AI commented Mar 2, 2026

Copy link
Copy Markdown
Contributor

The README lacked any information on the tech stack, how to run the project locally, or how GitHub Pages deployment works.

Changes

  • Tech stack — table covering TypeScript + React 19, Vite + @vitejs/plugin-react-swc, Tailwind CSS v4 via @tailwindcss/vite, and Radix UI
  • Local development — prerequisites (Node.js LTS, npm), plus npm ci, npm run dev, and npm run lint
  • Build & deploynpm run build / npm run preview, with a note on the Vite base: "/wouldreads/" config and what to change when forking or deploying elsewhere

All existing sections (About, Contributing, License) are untouched; new sections are inserted immediately after About.

Original prompt

Create a pull request in sheenyg/wouldreads that updates the repository README to include clearer sections for Tech stack, Local development, and Build & deploy.

Context

The current README is high-level and does not explain how to run the project locally or how GitHub Pages deployment works.

Current README (for reference):

Relevant repo details:

  • Uses npm (has package-lock.json)
  • package.json scripts include: dev, build, lint, preview
  • Vite base is configured for GitHub Pages at /wouldreads/ in vite.config.ts.

Requirements

  1. Update README.md to add a new Tech stack section that accurately reflects:
    • TypeScript + React + Vite
    • @vitejs/plugin-react-swc
    • Tailwind CSS via @tailwindcss/vite
    • Radix UI component library
  2. Add a Local development section including:
    • Prerequisites (Node.js LTS recommended, npm)
    • Install command: npm ci
    • Run command: npm run dev
    • Lint command: npm run lint
  3. Add a Build & deploy section including:
    • Build command: npm run build
    • Preview command: npm run preview
    • GitHub Pages note explaining Vite base: "/wouldreads/" and that it should be changed if repo name/deploy URL changes.
  4. Keep existing README content (About, Contributing, License) intact; insert the new sections in a logical place (e.g., after About).
  5. Ensure Markdown formatting is clean and readable.

Deliverables

  • A PR with the README update only (no unrelated formatting churn).
  • PR title suggestion: "docs: add tech stack and dev/build/deploy instructions to README".

This pull request was created from Copilot chat.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: sheenyg <25390061+sheenyg@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README to include clearer sections for tech stack and development docs: add tech stack and dev/build/deploy instructions to README Mar 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants