IPC144 course notes
For a long time, students at Seneca College have been using the class notes for course IPC144 at this website. For better maintenance, we are moving the notes into a new platform using Docusaurus. Docusaurus will convert the notes into markdown files to be hosted. The auto-conversion, however, has some limitations and we also want to have some customizations. Therefore, the students are joining hands to audit all the markdown files generated by Docusaurus.
The process of auditing
The page I decided to work on is A Simple Calculation. To start the work, I followed the basic workflow: fork and clone the repo, run the page locally, go through the checklist mentioned in the meta issue and was able to resolve some issues:
- fixed typo mistakes
- removed unnecessary markdown syntaxes: removing bold when the text is already wrapped in
inline code - added backticks for anything related to code
- added alt tags for photos to improve accessibility
- used admonitions for notes and additional information
- updated Frontmatter to include more tags:
id: a-simple-calculation
title: A Simple Calculation
sidebar_position: 2
slug: /B-Computations/a-simple-calculation
description: Create a computer program to solve a basic programming task
Receiving reviews
The great thing of working with open source is that we can get reviews from other developers. After sending the pull request, I got some suggestions from other students, mainly for some minor parts that need backticks but I didn't notice. I was also suggested to update the slug in Frontmatter to match with the standardized format.
Fixing a problem by one self is never enough. It is very helpful to have other people also looking at the same issue so we can get suggestions from multiple perspectives, which can give us an even better solution.
To know the detailed solution, read more in the issue and pull request.
Top comments (0)