Skip to content

docs: add missing new terminal instruction for frontend and fix header typo#16

Open
Mohit-001-hash wants to merge 1 commit into
Nkovaturient:mainfrom
Mohit-001-hash:fix-docs-onboarding
Open

docs: add missing new terminal instruction for frontend and fix header typo#16
Mohit-001-hash wants to merge 1 commit into
Nkovaturient:mainfrom
Mohit-001-hash:fix-docs-onboarding

Conversation

@Mohit-001-hash

Copy link
Copy Markdown

Description

This PR resolves two documentation issues to improve the onboarding experience:

  1. Missing Terminal Instruction: In the Quick Start guide, Step 1 starts a continuous Node server (node index.js), which blocks the terminal. Step 3 previously lacked the instruction to open a new terminal, which could confuse new contributors trying to run the frontend commands. I added a brief note to open a new terminal window.
  2. Header Typo: Fixed a typo in the main project header ([3rd Pize] -> [3rd Prize]).

Related Issue(s)

Fixes #None (just a documentation fix)

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Refactoring (code improvement without functional change)
  • 📝 Documentation update
  • 🚨 Breaking change (fix or feature that would cause existing functionality to not work as expected)

Architecture Impact

  • 🖥️ Frontend (React / Web Dashboard)
  • ☁️ AWS Pipeline / Backend
  • 💻 Electron Desktop App
  • 📖 General Documentation

Checklist:

  • My code follows the Contributing Guidelines of this project.
  • I have performed a self-review of my own code.
  • I have tested these changes locally and they generate no new warnings or errors.
  • I have NOT bypassed the AWS pipeline or hardcoded mock data in production builds.
  • I have checked that mobile responsiveness is maintained (if making UI changes).

Screenshots (if applicable)

None

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.

1 participant