Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding_learn.md file #655

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Adding_learn.md file #655

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions LEARN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Amupedia
Visit our website [Amupedia]https://www.amupedia.com/

## Table of Contents
- Introduction
- Features
- Getting Started
- Contribuitng Guidelines
- Code of Conduct

## Introduction
Amupedia is the biggest platform to help fellow students through their college program. This initiative will cater to the academic demands of the students and give assistance to them in every way possible. Everyone out there is running in the race to the top, and we here offer a push to anyone who needs it. Whether you come for the notes, read our blogs, or attend our events, you will emerge from Amupedia with new knowledge, perspective, influences, and connections.

## Features
- Providing you with all the quality stuff related to B.Tech, B.Com, B.E, and various other courses.
- The pdfs related to experiment, viva, quizzes question, the mid and end semester examination as well as the assignments.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the grammatical number of nouns:

  • Change "pdfs" to "PDFs" for proper capitalization.
  • Change "quizzes question" to "quiz questions" for correct pluralization.
-  - The pdfs related to experiment, viva, quizzes question, the mid and end semester examination as well as the assignments.
+  - The PDFs related to experiments, viva, quiz questions, mid and end semester examinations, as well as assignments.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- The pdfs related to experiment, viva, quizzes question, the mid and end semester examination as well as the assignments.
- The PDFs related to experiments, viva, quiz questions, mid and end semester examinations, as well as assignments.

- We are providing all this content for free.

## Getting Started
1). Fork the repository (Click the Fork button in the top right of this page, click your Profile Image)
2). Clone the forked repository to your local machine.
3). Make your branch from test branch.
```
git clone https://github.com/your-username/Project-Amupedia.git
```
4). Change the present working directory
```
cd Project-Amupedia
```
5).Make your changes
```
git add .
git commit -m "Your commit Message"
git push origin branch-name
```
6). Make a pull request.
- Star the repository.

#### Building Amupedia
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The heading "Building Amupedia" should be an h3 instead of h4 to maintain proper heading hierarchy.

- #### Building Amupedia
+ ### Building Amupedia
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
#### Building Amupedia
### Building Amupedia

- Install npm from browser(windows), using sudo apt install npm(linux) in the terminal
- In the root directory: npm install for downloading all the dependencies needed for the project
- Run npm run build for building the project
- Run npm run dev This will start the server on localhost:3000

## Contribuitng Guidelines
For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the markdown link format for better accessibility and readability.

- For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md
+ For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines](https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md
For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines](https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md)


## Code of Conduct
For all the enthusiastic contributers, please refer to the [Code of Conduct]https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the markdown link format for better accessibility and readability.

- For all the enthusiastic contributers, please refer to the [Code of Conduct]https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file
+ For all the enthusiastic contributors, please refer to the [Code of Conduct](https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
For all the enthusiastic contributers, please refer to the [Code of Conduct]https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file
For all the enthusiastic contributors, please refer to the [Code of Conduct](https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file)


Happy Coding!!
Comment on lines +1 to +51
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please address the following formatting issues to improve the readability and structure of the document:

  • Ensure that headings are surrounded by blank lines.
  • Correct the indentation of unordered lists.
  • Ensure that fenced code blocks are surrounded by blank lines and specify the language for syntax highlighting.
- # Amupedia
+ # Amupedia
+
- ## Table of Contents
+ ## Table of Contents
+
- ## Introduction
+ ## Introduction
+
- ## Features
+ ## Features
+
- ## Getting Started
+ ## Getting Started
+
- ### Building Amupedia
+ ### Building Amupedia
+
- ## Contribuitng Guidelines
+ ## Contribuitng Guidelines
+
- ## Code of Conduct
+ ## Code of Conduct
+
-  - Introduction
+ - Introduction
-  - Features
+ - Features
-  - Getting Started
+ - Getting Started
-  - Contribuitng Guidelines
+ - Contribuitng Guidelines
-  - Code of Conduct
+ - Code of Conduct
-  - Providing you with all the quality stuff related to B.Tech, B.Com, B.E, and various other courses.
+ - Providing you with all the quality stuff related to B.Tech, B.Com, B.E, and various other courses.
-  - The PDFs related to experiments, viva, quiz questions, mid and end semester examinations, as well as assignments.
+ - The PDFs related to experiments, viva, quiz questions, mid and end semester examinations, as well as assignments.
-  - We are providing all this content for free.
+ - We are providing all this content for free.
-  - Install npm from browser(windows), using sudo apt install npm(linux) in the terminal
+ - Install npm from browser(windows), using sudo apt install npm(linux) in the terminal
-  - In the root directory: npm install for downloading all the dependencies needed for the project
+ - In the root directory: npm install for downloading all the dependencies needed for the project
-  - Run npm run build for building the project
+ - Run npm run build for building the project
-  - Run npm run dev This will start the server on localhost:3000
+ - Run npm run dev This will start the server on localhost:3000
-  ```
+  ```
-  git clone https://github.com/your-username/Project-Amupedia.git
+  git clone https://github.com/your-username/Project-Amupedia.git
-  ```
+  ```
-  cd Project-Amupedia
+  cd Project-Amupedia
-  ```
+  ```
-  git add .
+  git add .
-  git commit -m "Your commit Message"
+  git commit -m "Your commit Message"
-  git push origin branch-name
+  git push origin branch-name
-  ```
+  ```
- - Star the repository.
+ - Star the repository.

Loading