docs: update

docs/changelog.md

@@ -4,7 +4,7 @@ All notable changes to this project after v1.0 will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
-## [1.0] - 2024-??-??
+## [1.0] - 2024-02-25
 
 ### Added
 

docs/index.md

@@ -1,9 +1,9 @@
 # RenderCV
 
-[![tests](https://github.com/sinaatalay/rendercv/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/sinaatalay/rendercv/actions/workflows/test.yaml)
+[![tests](https://github.com/sinaatalay/rendercv/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/sinaatalay/rendercv/actions/workflows/tests.yaml)
 [![coverage](https://coverage-badge.samuelcolvin.workers.dev/sinaatalay/rendercv.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/sinaatalay/rendercv)
 [![pypi-version](https://img.shields.io/pypi/v/rendercv?label=PyPI%20version&color=rgb(0%2C79%2C144))](https://pypi.python.org/pypi/rendercv)
-[![pypi-downloads](https://img.shields.io/pepy/dt/rendercv?label=PyPI%20downloads&color=rgb(0%2C%2079%2C%20144))](https://pypi.python.org/pypi/rendercv)
+[![pypi-downloads](https://img.shields.io/pepy/dt/rendercv?label=PyPI%20downloads&color=rgb(0%2C%2079%2C%20144))](https://pypistats.org/packages/rendercv)
 
 
 RenderCV is a $\LaTeX$ CV/resume generator from a JSON/YAML input file. The primary motivation behind the RenderCV is to allow the separation between the content and design of a CV.
@@ -40,7 +40,7 @@ cv:
         institution: University of Pennsylvania
         area: Computer Science
         degree: BS
-    employment:
+    experience:
     ...
 ```
 
@@ -116,7 +116,7 @@ A detailed user guide can be found [here](https://sinaatalay.github.io/rendercv/
 
 Reference to the code can be found [here](https://sinaatalay.github.io/rendercv/reference).
 
-The changelog can be found [here](https://sinaatalay.github.io/rendercv/user_guide).
+The changelog can be found [here](https://sinaatalay.github.io/rendercv/changelog).
 
 ## Contributing
 

docs/user_guide.md

@@ -78,11 +78,15 @@ The `cv` section of the YAML input starts with generic information, as shown bel
 ```yaml
 cv:
   name: John Doe
-  email: johndoe@example.com
+  location: Your Location
-  phone: "+905555555555"
+  email: youremail@yourdomain.com
-  website: https://example.com
+  phone: tel:+90-541-999-99-99
-  label: Mechanical Engineer
+  website: https://yourwebsite.com/
-  location: Istanbul, Türkiye
+  social_networks:
+    - network: LinkedIn
+      username: yourusername
+    - network: GitHub
+      username: yourusername
   ...
 ```
 
@@ -93,11 +97,15 @@ The real content of your CV is stored in a field called sections.
 ```yaml
 cv:
   name: John Doe
-  email: johndoe@example.com
+  location: Your Location
-  phone: "+905555555555"
+  email: youremail@yourdomain.com
-  website: https://example.com
+  phone: tel:+90-541-999-99-99
-  label: Mechanical Engineer
+  website: https://yourwebsite.com/
-  location: Istanbul, Türkiye
+  social_networks:
+    - network: LinkedIn
+      username: yourusername
+    - network: GitHub
+      username: yourusername
   sections:
     ...
     YOUR CONTENT
@@ -136,7 +144,7 @@ cv:
 
 There are six different entry types in RenderCV. Different types of entries cannot be mixed under the same section, so for each section, you can only use one type of entry.
 
-The available entry types are: `EducationEntry`, `ExperienceEntry`, `PublicationEntry`, `NormalEntry`, `OneLineEntry`, and `TextEntry`.
+The available entry types are: [`EducationEntry`](#education-entry), [`ExperienceEntry`](#experience-entry), [`PublicationEntry`](#publication-entry), [`NormalEntry`](#normal-entry), [`OneLineEntry`](#one-line-entry), and [`TextEntry`](#text-entry).
 
 Each entry type is a different object (a dictionary). All of the entry types and their corresponding look in each built-in theme are shown below:
 
@@ -249,7 +257,7 @@ The process of generating $\\LaTeX$ files like this is called "templating," and
 
 If you want to have some `design` options under your YAML input file's `design` section for your custom theme, you can create a `__init__.py` file inside your theme directory.
 
-For example, the `moderncv` theme's `__init__.py` file is shown below:
+For example, an `__init__.py` file is shown below:
 
 ```python
 from typing import Literal
@@ -264,7 +272,7 @@ class YourcustomthemeThemeOptions(pydantic.BaseModel):
     option4: bool
 ```
 
-Then, RenderCV will parse your custom design options, and you can use these variables inside your `*.j2.tex` as shown below:
+Then, RenderCV will parse your custom design options from the YAML input, and you can use these variables inside your `*.j2.tex` files as shown below:
 
 ```latex
 <<design.option1>>