Skip to content

Commit

Permalink
Article improvements
Browse files Browse the repository at this point in the history
Signed-off-by: Amr Elmohamady <[email protected]>
Signed-off-by: Shivam Deepak Chaudhary <[email protected]>
  • Loading branch information
amrdb authored and scshiv29-dev committed Nov 5, 2024
1 parent 0c8bb5d commit 01e547d
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions articles/YYYYMMDD_article_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: "Title of the Article. The title should be a max. of 55 characters."
description: "A brief description of what the article covers. The description should be a maximum of 160 characters."
date: YYYY-MM-DD
author: "Author Name"
tags: ["one", "two", "three"]
---

# Title of the Article

## Introduction

*[Write at least two paragraphs introducing the topic. Provide some background and explain why this topic is important. Use inline links for definitions where appropriate, e.g., [term](/definitions/term.md).]*

### TL;DR

- **Bullet Point Summary**: *[Summarize the key points in a few bullet points for quick reference.]*

## Subtitle 1

*[Write the content of the first section here. Use clear and concise language, and ensure that each paragraph flows logically to the next. Continue to use inline links for definitions and sitemap articles where appropriate.]*

**Key Point:** *[Highlight key information here.]*

### Subheading (if needed)

*[Additional details or subtopics related to the main heading.]*

## Subtitle 2

*[Write the content for the second major section of your article.]*

- **Bullet Point 1**: *[Use bullet points to list key points or steps if applicable.]*
- **Bullet Point 2**: *[Continue listing key points here.]*

### Code Example

```python
# Provide code examples if relevant, ensuring they are well-commented and easy to understand
print("Hello, World!")
```

### Image or Diagram

*[If you reference images, note them here but store the actual image in the /assets folder]*

![Description of Image](/assets/YYYYMMDD_title_of_the_article_img1.png)

## Subtitle 3

*[Continue with more sections as needed.]*

**Note:** *[Include any relevant notes or tips here.]*

## Conclusion

*[Summarize the key points discussed in the article. Optionally, propose next steps or further reading.]*

## References

*[Cite any sources or references used in the article.]*

*[Add links to related articles or further reading that might interest the reader.]*

<!-- Note on Definitions -->
<!-- Throughout this article, link relevant terms to their definitions using inline Markdown links. -->
<!-- Format: [term](/definitions/term.md) -->
<!-- If a definition doesn't exist, create it in the definitions directory and link to it. -->

0 comments on commit 01e547d

Please sign in to comment.