Built and Run by AUites
Welcome to the official AUwide resource sharing repository. The following is made for reference purposes only. All resources shared here are free and open source. You may clone them at Your Own Risk.
If you are new here, check out the Newbies section.
This is a FOSS library for the true AUite. You may use it as a reference or as a source. Please refrain from citing the entire repository for any material you may or may not have referred from the repository.
All contributions are truly welcome. You can submit resources, change the source code, update the documentation, fix bugs or make additional changes as and when required.
With respect to submission of resources, we request you to submit only complete and correct resources. Please go through the Contribution Guidelines before contributing to the repository.
We follow semantic versioning for all major updates. All contributions are subject to being reviewed by the community.
Partial Pull Requests will not be entertained. If you are unable to work upon an assigned task, feel free to contact the community on the respective github issues page or via our Discord server.
This website is built using Docusaurus 2, a modern static website generator.
- Node.js version 14 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
git clone {link of your fork}
cd AUdocs
npm install
npm run start
Please follow this guide for all contributions. If you are new to git and github, we request you to go through the Newbies section.
You may also discuss contributions and other stuff on our discord server.
You can submit resources using one of the following two methods.
You may create an issue on this repository listing the resource you want to submit. Please mention the following for any resource you would like to submit. Please follow the following template structure when you create an issue to submit resources.
Issue Title: Resource Update: <Resource Type>/<Resource Name>
Resource Title:
Resource Course:
Resource Type: // (Project, Reference, Book, Guide, Exam Paper)
Resource Links: // place the drive links shared across the university.
You may directly update the resources by forking the repository, updating the resources you want to contribute at the specific location and then opening a pull request. We request you to open only complete pull requests. Every pull request would be reviewed in order to maintain the repository structure.
You may submit patches to the repository wherever you feel they are required. Please do not open issues and submit patches for minor gramatical errors and spacing corrections. Such updates would then be considered in the next patch submission. We also request you to discuss any major changes with the community before opening a pull request.
All courses are supposed to be housed in their respective locations. You can generally figure out the location based on the folder structure. Every course must only have one file consisting of all the links to the respective material.
The file for the respective course must be named as follows
CourseName.md
If the course name contains multiple words, you may seperate them using a hyphen.
The file must be placed in accordance with its position in the documentation. For example: A Language course such as french being offerred in the School of Arts and Sciences should be placed along the following path /docs/schools/sas/conversational-french.md
- We request you to check your commits for repetitive commits before updating content to the documentation.
- We follow the contributor's covenent as a structure for our community.