Update README.md (#211)

* feat: Move Contributors to README.md

* feat: Condense README.md

* fix: Link REQUIRMENTS.md in README.md

* fix: Update Resourses Sidebar

* fix: Update Resources Sidebar pt.2

* CS program -> CS programs

* fix formatting

---------

Co-authored-by: Tanzim Hossain <tanzimfh@gmail.com>

README.md

@@ -1,153 +1,88 @@
 # UWindsor CS Wiki
 
-This repository contains the source code for the University of Windsor Computer Science Wiki.
+This repository contains the source code for the University of Windsor Computer Science Wiki, a collection of resources, guides, and information designed for students in the University of Windsor's Computer Science programs.
 
-The Wiki is a collection of resources, guides, and information for students in the Computer Science program at the University of Windsor.
+## Requirements
 
-## Dependencies
+- **Node.js** (>=14)
+- **PNPM** ([Installation Guide](https://pnpm.io/installation))
+- **Git** ([Installation Guide](https://git-scm.com/downloads))
 
-- **Nodejs** version >= 14 or above
+## Installation
 
-- **PNPM** [Guide](https://pnpm.io/installation)
-
-- **NPM** [Guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
-
-- **git**
-
-# How to Install
-
-## Install Dependencies for Windows users
-
-Download the [Nodejs installer](https://nodejs.org/en/download/) from their Official website.
-
-### Install PNPM
-
-```
-npm install --global pnpm
-```
-
-### Install Git
-
-Download [Git Installer](https://git-scm.com/download/win) from their Official website.
-
-## Install Dependencies for Mac Users
-
-Download [Nodejs installer](https://nodejs.org/en/download/) from their Official website.
-
-Alternatively:
-
-### Using Homebew
-
-```
-brew install node
-```
-
-### Using MacPorts
-
-```
-sudo port install nodejs17
-```
-
-### Install PNPM
-
-```
-npm install --global pnpm
-```
-
-### Install Git
-
-There are several ways to install Git on a Mac. The easiest is probably to install the Xcode Command Line Tools.
-
-Verify git
-
-```
-git --version
-```
+### Windows
 
-## Install Dependencies for Debian / Ubuntu
+1. [Download Node.js](https://nodejs.org/en/download/)
+2. Install PNPM:
+    ```bash
+    npm install --global pnpm
+    ```
+3. [Install Git](https://git-scm.com/download/win)
+
+### macOS
+
+1. [Download Node.js](https://nodejs.org/en/download/) or use:
+    ```bash
+    brew install node
+    # OR
+    sudo port install nodejs17
+    ```
+2. Install PNPM:
+    ```bash
+    npm install --global pnpm
+    ```
+3. Install Git via Xcode Command Line Tools:
+    ```bash
+    git --version
+    ```
+
+### Linux (Debian/Ubuntu)
 
 ```bash
-sudo apt update
-sudo apt install git npm -y
+sudo apt update && sudo apt install git npm -y
 npm install --global pnpm
 ```
 
-### Install Git
-
-```
-sudo apt install git-all
-```
-
 ## Local Development
 
-1. Clone the repo
-
-```bash
-git clone git@github.com:UWindsorCSS/Wiki.git
-```
-
-2. Install all dependencies
-
-```console
-pnpm install
-```
-
-3. Start the Server
-
-```console
-pnpm start
-```
-
-This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
-
-Open web browser the enter the address `http://localhost:3000/wiki/`
-
-**Alternatively, Use following command to access application from other machine in your network:**
-
-`pnpm start --host 0.0.0.0`
-
-Open web browser the enter the address `http://ip-address-of-other-machine:3000/wiki/`
+1. Clone the repository:
+    ```bash
+    git clone git@github.com:UWindsorCSS/Wiki.git
+    ```
+2. Install dependencies:
+    ```bash
+    pnpm install
+    ```
+3. Start the server:
+    ```bash
+    pnpm start
+    ```
+    Open: `http://localhost:3000/wiki/`
 
 ## Build
 
-```console
+Generate static content:
+
+```bash
 pnpm build
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Important to know:
-
-The **search bar** feature **ONLY** works when you run `pnpm build`. It will **NOT** work when you run `pnpm start`
-
-## Deployment
+## Serve
 
-### Linux
-
-```console
-GIT_USER=<Your GitHub username> USE_SSH=true pnpm deploy
-```
-
-### Windows
+Serve static content after building:
 
-```console
-cmd /C 'set "GIT_USER=uwindsorcss" && pnpm deploy'
+```bash
+pnpm serve
 ```
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
-
-## Formatting
-
-We use [prettier](https://prettier.io). Prettier automatically formats markdown and javascript so it is extremely useful to use.
-
-This **MUST** be run before making a pull request
+## Article Requirements
 
-You can run prettier by running the following command:
+Refer to the [Article Requirements](REQUIREMENTS.md) for more information on how to write articles.
 
-```
-pnpm format
-```
+## Contributors
 
-## Article Requirements
+Thank you to all the contributors who made this wiki possible!
 
-Please read about it at `REQUIREMENTS.md`
+<a href="https://github.com/uwindsorcss/wiki/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=uwindsorcss/wiki" />
+</a>

resources/guides/contributing.md

@@ -111,10 +111,6 @@ The process of contributing may seem daunting at first if you've never done it b
 
 When creating your pull request, you may receive comments and suggested changes to make before a CSS developer will merge your code. If this happens, you should make the suggested changes locally and then commit and push them to your fork. The pull request will automatically be updated.
 
-## Giving Yourself Credit
-
-To thank everyone for their contributions to the wiki, we've created [a page dedicated to showcasing all of our contributors](/resources/contributors). Make sure you add yourself to this list so you can be recognized for your work! Feel free to add your GitHub, personal website, and/or your email address as well.
-
 ## More Resouces
 
 Check out the [Docusaurus documentation](https://docusaurus.io/docs) for more information on how Docusaurus works!

resources/guides/navigation-guide/sitemap.json

@@ -14,10 +14,6 @@
             "name": "Useful Links",
             "loc": "https://uwindsorcss.github.io/wiki/resources/useful_links"
         },
-        {
-            "name": "Our Contributors",
-            "loc": "https://uwindsorcss.github.io/wiki/resources/contributors"
-        },
         {
             "name": "How to Contribute",
             "loc": "https://uwindsorcss.github.io/wiki/resources/guides/contributing"

resources/resources-sidebars.ts

@@ -23,9 +23,5 @@ export default {
                 "guides/becoming-a-ta",
             ],
         },
-        {
-            type: "doc",
-            id: "contributors",
-        },
     ],
 };