# Reading Materials End to End Procedure

<Section>

## Concepts

<IndexList>
<IndexItem href="introduction">Introduction</IndexItem>
<IndexItem href="markdown">Markdown</IndexItem>
<IndexItem href="outcome">Outcome</IndexItem>
<IndexItem href="samples">Sample RMs</IndexItem>
<IndexItem href="instructions">Instructions</IndexItem>
<IndexItem href="guidelines">Formatting Guidelines</IndexItem>
<IndexItem href="checklist">Checklist</IndexItem>
<IndexItem href="configuration">Checklist</IndexItem>
</Section>

<Section id="introduction">
The reading materials are used to explain the concepts said in the sessions. This will provide crisp information about what was discussed in the video session. To prepare the reading materials we use Markdown language.
</Section>

<Section id="markdown">
Markdown is a simple and lightweight markup language that allows you to format text and create documents with ease. It is used to format text, create lists, add links and images, and more.

Generally, the reading materials are developed in VS Code. Create a file with the file extension .md in the relevant folder in VS Code.

(Download and install VS Code from Chrome)

#### [Learn Markdown](https://www.markdownguide.org/basic-syntax/)
#### [Markdown Previewer](https://dillinger.io/)

We have our own custom built markdown previewer.

#### [Our Markdown previewer](https://react-markdown-preview-web-alpha.earlywave.in/markdown-preview)

Try out our Markdown previewer.
</Section>

<Section id="outcome">
### Outcome of the Reading Material:

* The user should be revised with all the concepts that are discussed in the video session.
</Section>

<Section id="samples">
### Sample Reading Materials:

* You can go through the reading material that are present in different courses in the learning platform or you can find the sample markdown in [this](https://hackmd.io/@Chanakya/ryGQ0Eias) link. (Copy paste the description in our markdown previewer to check the preview)
* The reading material that you are going through now is also one of the sample for reading material.
</Section>

<Section id="instructions">
### Reading Material Preparation Instructions

* Create a markdown file with the name as the unit name in snake_case
Ex: introduction_to_framework.md
* Read and understand the concepts that are going to be discussed in the reading materials and do hands-on of those on the topics discussed.
* Write a simple and best statement by inspiring from the provided resources.
* Use Grammarly to check the grammar of the sentences.
* Add images if required to explain the concepts more clearly.
* You can upload images to [Cloudinary](https://cloudinary.com/console) to get the image URLs.
* Add notes, tips, warnings if needed after.
* Format into Sections and add Concepts at the beginning of the Reading Material.
* Add Concepts list at the beginning of the Reading Material
</Section>

<Section id="guidelines">

## Formatting Guidelines:

* Every reading material should have a Main heading and each section should have a heading
* For the main heading use # and next level heading use ##.
* Use numbering for Headings and for the Sub-Headings In a section, ## 1. Heading ### 1.1 Sub-Heading 1.1.1 Sub-Heading
* Use backticks (``) for variables, methods, classes, and any keywords.
* Use code formatting specific code the code.
</Section>

<Section id="checklist">

## Checklist

- [ ] Used the standard terminology.
- [ ] Added Introduction and Summary.
- [ ] Used backticks for methods, properties, variables.. etc.
- [ ] Used the same punctuation, same text case throughout the reading material.
- [ ] Added Concepts list at the begining of the Reading Material
- [ ] Checked the content with grammarly.
- [ ] The code is properly formatted.
- [ ] Followed heading(Section) hierarchies
</Section>
---

[Yet to be Updated]
<Section id="configuration">

## Configuring Reading Materials

[Yet to be Updated]
https://docs.google.com/document/d/1WlkFKvAUalnO7iqgPXAe3Lktmot77Qi3XZOFtkIgC3Q/edit
</Section>