Merge pull request #89 from UMLCloudComputing/chore/Update-README

Chore/update readme

Author: Gurpranked

README.md

@@ -12,10 +12,10 @@ This is the official repo for the UML Cloud Computing Club's website.
 The website is implemented using [Docusaurus](https://docusaurus.io/), [MUI](https://mui.com/), and some fundamental [ReactJS](https://react.dev/).
 
 
-## 👨‍💻 Activities and Resources Contribution Guidelines
+## 👨‍💻 Content File Structure & Resources Contribution Workflow
 <details>
 <summary>View Contents</summary>
-To edit the activities sections or the resources section of the website:
+To edit the resources section of the website:
 
 1. Create a new branch from the **main** branch
 2. Make the appropriate edits within this branch
@@ -33,6 +33,12 @@ All markdown files containing blog details are in **blog/** with the specific bl
 
 All markdown files should follow Docusaurus's guidelines for folder structure for autogenerating the UI and pagination. More details are available at the [Docusaurus Docs](https://docusaurus.io/docs/sidebar/autogenerated) and [Docusaurus Blog](https://docusaurus.io/docs/blog). 
 
+
+> [!IMPORTANT] 
+> All contributions to the UML Class Sesources section within the the `resources/` folder must follow the *explicitly* provided guidelines and rules in the aptly named file `📒 Guidelines & Rules`. 
+> Failure to do so will result in your contributions being removed or rejected within PRs!
+> These are resources for official UML CS courses and hence will be monitored closely.
+
 </details>
 
 ## 🔊 Adding Blogs
@@ -135,11 +141,15 @@ If you're interested in adding any local files to your blog pages, simply place
 
 </details> 
 
-## 🛤️ Adding New Repository to Project Docs
+## 🛤️ Adding New Repository to Project Docs/Activities Section
 
 <details>
 <summary>View Contents</summary>
 
+<details>
+<summary>Project Details</summary>
+
+### Project
 To add a new project's documentation onto the project docs section of the website, you must meet a few pre-reqs:
 
 1. The project must be a remote git repository (Github, BitBucket, etc)
@@ -150,40 +160,63 @@ To add a new project's documentation onto the project docs section of the websit
                 └── intro.md | Introduction/
                     _category_.json
     ```
-3. The project's documentation files must follow [Docusaurus's](https://docusaurus.io/docs/create-doc) doc creation guidelines. <br/> The `_category_.json` file is autogenerated at website build time. The order in which the projects are displayed on the website is determined by the order in which the projects are listed in the `repos.json` file (top to bottom order).
+3. The project's documentation files must follow [Docusaurus's](https://docusaurus.io/docs/create-doc) doc creation guidelines. <br/> The `_category_.json` file is autogenerated at website build time. The order in which the projects are displayed on the website is determined by the order in which the projects are listed in the `project_repos.json` file (top to bottom order).
 4. Front Matter requirements: All markdown files must have the following front-matter: (`#` is an integer). This will affect the order in which the doc pages are displayed on the website (top to bottom order). 
-``` text
----
-sidebar_position: #
----
-```
+    ``` text
+    ---
+    sidebar_position: #
+    ---
+    ```
 
-Here the label should be your own. The label indicates the labeled name of the folder or subfolder to be shown. IE project name (`My Project`), subsection name (`Excersices`), etc. <br/>
-The position value should also be customized to an `integer` representing the position of your folder or subfolder relative to other subfolders. 
+#### In order to add your project:
+1. Create a new branch from the **main** branch
+2. Name the branch with the following convention: `feat: Add new project docs: PROJECTNAME` with `PROJECTNAME` being the name of your project.
+3. Add your repository to package.json. Add your project as a key-value pair in the `project_repos.json`:
+    ``` json
+    {
+        "<Other Project>": "<Other Project Github URL>",
+        "<Your Project Name>": "<Your Project Github URL>",
+    }
+    ```
+4. Make a Pull Request to merge your branch into **main**. Your project will be added to the website once the PR is approved and merged.
+</details>
 
-> [!IMPORTANT]
-> Be sure to check the position values of current project docs. Do not place conflicting position values to other projects.<br/> In the example below, both `react-mui-resume` and `rowdybot` cannot have the same position values within their `_category_.json` files. Avoid these conflicts in your `_category_.json` files!
 
-``` shell
-react-mui-resume
-│   ├── _category_.json
-│   └── Intro.md
-├── rowdybot
-│   ├── _category_.json
-│   └── Intro.md
-```
+<details>
+<summary>Activity Details</summary>
+
+### Activity
+To add a new activity's instructions onto the activities section of the website, you must meet a few pre-reqs:
 
-### In order to add your project:
+1. The activity must be a remote git repository (Github, BitBucket, etc)
+2. The activity's repository must contain folder with the following structure: <br/>
+    ``` shell
+        docs 
+        └── web_docs 
+                └── intro.md | Introduction/
+                    _category_.json
+    ```
+3. The activity's documentation files must follow [Docusaurus's](https://docusaurus.io/docs/create-doc) doc creation guidelines. <br/> The `_category_.json` file is autogenerated at website build time. The order in which the activities are displayed on the website is determined by the order in which the projects are listed in the `activity_repos.json` file (top to bottom order).
+4. Front Matter requirements: All markdown files must have the following front-matter: (`#` is an integer). This will affect the order in which the doc pages are displayed on the website (top to bottom order). 
+    ``` text
+    ---
+    sidebar_position: #
+    ---
+    ```
+
+### In order to add your activity:
 1. Create a new branch from the **main** branch
-2. Name the branch with the following convention: `feat: Add new project docs: PROJECTNAME` with `PROJECTNAME` being the name of your project.
-3. Add your repository to package.json. Add your project as a key-value pair in the json file:
-``` json
-{
-    "<Other Project>": "<Other Project Github URL>",
-    "<Your Project Name>": "<Your Project Github URL>",
-}
-```
-4. Make a Pull Request to merge your branch into **main**. Your project will be added to the website once the PR is approved and merged.
+2. Name the branch with the following convention: `feat: Add new activuty docs: ACTIVITYNAME` with `ACTIVITYNAME` being the name of your project.
+3. Add your repository to package.json. Add your project as a key-value pair in the `activity_repos.json`:
+    ``` json
+    {
+        "<Other Activity>": "<Other Activity Github URL>",
+        "<Your Activity Name>": "<Your Activity Github URL>",
+    }
+    ```
+4. Make a Pull Request to merge your branch into **main**. Your activity will be added to the website once the PR is approved and merged.
+
+</details>
 
 </details>