1. Issue
The IPC144 notes are written in 30 Markdown files. These files have been automatically translated to Markdown so it might contain typos and some misuse syntaxes. My task is to find and fix those issues to make the Markdown file become consistent and readable.
2. Modification Process
After getting assigned to string-library.md file which I want to work on, I forked, cloned IPC144's repo to my local machine and read through the CONTRIBUTING.md to set up and run the project locally.
Then I created a new branch and started finding and fixing existing errors. Here are some modifications I made:
- Fix typo
- Replace block quotes with admonitions
Thanks to Docusaurus which supports admonitions, I can make use of this feature to display note for a better readability.
:::note
We have allocated 62 characters to accommodate 30+30 characters plus the blank space separator and the null terminator byte.
:::
The above code will be displayed as:
- Remove extra white spaces in code blocks
- Fix frontmatter
I update the frontmatter with more information:
---
id: string-library
title: "String Library"
sidebar_position: 2
slug: /refinements/string-library
description: "String library is a standard library to process character strings"
---
- Add inter-site links to other page
Linking to another page which has related information helps learners to review the knowledge so I decided to add some links to the file:
The standard library that ships with [C compilers](/A-Introduction/compilers#the-c-compiler "C compiler") and processes [character strings](/F-Refinements/character-strings "Character Strings") is called the string library.
- Add bold emphasis for some words
3. Getting reviewed
After summitting a PR, Leyang Yu suggested me to replace the headings for String Length, Copy, Compare, and Concatenate with the third level heading. It's totally appropriate so I applied it and here is the final result:
The process was interesting and enjoyable!
Top comments (0)