CMP-Docs.Demo.mp4
I was motivated to create an online platform that takes the form of software documentation as a guide for those that are considering enrolling, have enrolled or even have graduated from the department! After meeting with prospective students to help them decide whether or not to join the department and teaching a summer course to freshmen, I realized that a lot of questions are being repeatedly asked every year; it dawned on me that it would be really nice if answers to all such questions and more information about the computer engineering department at Cairo university were all available in one site.
You can check the documentation at https://cmp-docs.pages.dev or https://cmp-docs.netlify.app
Thereby, the following are the motivations of this website:
✦ Provide prospective students all the information they need to make an informed decision regarding whether or not to choose computer engineering
✦ Guide students that have just entered the department on how to cope and get ready for what's next. Some sections of the website will be even useful to graduate students!
✦ Realize the fact, that we are all one family; and that we are all ready to help one another no matter how far we are from each other.
Beware, this effort is entirely controlled by us students. No professors are involved and this is not official in any sense.
It should be self-evident from the side bar; however, here is a small guide:
| Student Type | Consideration |
|---|---|
| Prospective Students | Review the "Before Joining" section in the sidebar. If you have any unanswered questions, please create a GitHub issue. |
| Recent Students | Consider the "Recently Joined" section. |
| All Other Students | Consider all mentioned sections and feel free to collaborate! |
Important Note I: The website is built to be updated continually; thus, checking it frequently for updates or changes is key.
Important Note II: The website is built with Arabic in mind. However, with this being initially written in English it may take some time until the Arabic versions of all pages are available. Collaboration here would be really helpful here.
The website is built with collaboration in mind. In particular, as a student part of the department, you are welcome to change any part of the content found within the website with zero web development coding prerequisites.
✦ Modifying any existing page takes only modifying its corresponding markdown or yaml file. A page in the documentation is represented by yaml (which also supports markdown in strings) only if it contains a grid of icons; otherwise, it's pure markdown. This all gets transpiled to html and css under the hood.
✦ You can even modify the sidebar to include new sections and pages and guess what! The sidebar is a single yaml file.
Hint I: It should only take you 10 minutes to get the hang of markdown or yaml syntax, assuming the unlikely coincidence that you don't know about them.
Hint II: All files corresponding to the website can be found inside "public/department". They follow the same hierarchy as the sidebar.
To run for the first time, install Node.js then type at the terminal
npm install
Now you can test any changes you perform by running
npm start
Once you're done. Simply submit a PR; it would be nice if you start proposing the PR as an issue if it's a big change.
What are you waiting for? Be part of this project by considering one of the outstanding tasks. Most important of which are adding your class to the site if it's not already there.
-
Please only write facts that you are certainly sure of; if it's controversial please discuss it in an issue first. It's best to either naturally deduce your argument or use references rather than just stating facts as if they were universal truisms.
-
Using gifs or emojis is highly recommended to keep the site lively
- Lists do not render natually
- HTML and Latex are not yet supported