Init mkdocs.

.markdownlint.yaml

@@ -0,0 +1,7 @@
+---
+default: true
+
+# MD007/ul-indent - Unordered list indentation
+MD007:
+  # Spaces for indent
+  indent: 4

CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change Log
+
+## 0.1.0
+
+**Qian** (The Creative, Heaven) 🌤️ (乾):
+
+- [x] Setup the framework for wrappers that can be used directly
+    in the production code.
+    - [x] Set up the BaseWrapper
+    - [x] Set up the StringWrapper
+- [x] Setup the config framework
+- [ ] Setup the experiment main function
+- [ ] Setup the evaluator framework to do evaluations
+    - [ ] One auto-evaluator
+    - [ ] Ground truth matching
+    - [ ] Human evaluator
+- [ ] Interactive evaluator
+- [ ] Reader framework that be able to process different data
+    - [ ] One reader from csv
+- [ ] Output formatter
+    - [ ] Output to csv
+    - [ ] Basic Textual UI
+- [x] Output parser - Capture detailed information
+- [ ] Documents
+- [ ] Git setup
+- [ ] Cotribution guid
+- [ ] End2End Examples
+- [ ] Release

README.md

@@ -4,32 +4,41 @@
 [![Code style: yapf](https://img.shields.io/badge/code%20style-yapf-blue)](https://github.com/google/yapf)
 
 ## Introduction
-YiVal is an innovative open-source project, rooted in the principles of the Yijing, focused on revolutionizing the end-to-end evaluation process of AI models. We aim to provide comprehensive insights into not only the individual components such as models and prompts but more importantly, the final output produced by their interaction.
+
+YiVal is an innovative open-source project,
+rooted in the principles of the Yijing,
+focused on revolutionizing the end-to-end evaluation process of AI models.
+We aim to provide comprehensive insights into not only the individual components
+such as models and prompts but more importantly,
+the final output produced by their interaction.
 
 ## Result SxS
-<img width="1698" alt="Screenshot 2023-07-27 at 3 05 20 PM" src="https://github.com/YiVal/YiVal/assets/1544154/c667a749-8bdc-469e-a2d2-5086f7bac73e">
-
-
-## v 0.1.0
- **Qian (The Creative, Heaven) 🌤️ (乾):** 
- - [x] Setup the framework for wrappers that can be used directly in the production code.
-     - [x] Set up the BaseWrapper
-     - [x] Set up the StringWrapper      
- - [x] Setup the config framework
- - [ ] Setup the experiment main function
- - [ ] Setup the evaluator framework to do evaluations
-     - [ ] One auto-evaluator
-     - [ ] Ground truth matching
-     - [ ] Human evaluator
- - [ ] Interactive evaluator
- - [ ] Reader framework that be able to process different data
-     - [ ] One reader from csv
- - [ ] Output formatter
-     - [ ] Output to csv
-     - [ ] Basic Textual UI
- - [x] Output parser - Capture detailed information
- - [ ] Documents
- - [ ] Git setup
- - [ ] Cotribution guid
- - [ ] End2End Examples
- - [ ] Release       
+
+![SxS](https://github.com/YiVal/YiVal/assets/1544154/c667a749-8bdc-469e-a2d2-5086f7bac73e)
+
+## Roadmap
+
+**Qian** (The Creative, Heaven) 🌤️ (乾):
+
+- [x] Setup the framework for wrappers that can be used directly
+    in the production code.
+    - [x] Set up the BaseWrapper
+    - [x] Set up the StringWrapper
+- [x] Setup the config framework
+- [ ] Setup the experiment main function
+- [ ] Setup the evaluator framework to do evaluations
+    - [ ] One auto-evaluator
+    - [ ] Ground truth matching
+    - [ ] Human evaluator
+- [ ] Interactive evaluator
+- [ ] Reader framework that be able to process different data
+    - [ ] One reader from csv
+- [ ] Output formatter
+    - [ ] Output to csv
+    - [ ] Basic Textual UI
+- [x] Output parser - Capture detailed information
+- [ ] Documents
+- [ ] Git setup
+- [ ] Cotribution guid
+- [ ] End2End Examples
+- [ ] Release

docs/changelog.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD041 -->
+--8<-- "CHANGELOG.md"

docs/index.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD041 -->
+--8<-- "README.md"

mkdocs.yml

@@ -0,0 +1,68 @@
+---
+site_name: YiVal
+nav:
+  - Index: index.md
+  - Contributing Guide: contributing.md
+  - Change Log: changelog.md
+
+theme:
+  name: material
+  palette:
+    cheme: slate
+    primary: lightgreen
+    accent: purple
+  logo: fontawesome/brands/github
+  favicon: fontawesome/brands/github
+  icon:
+    repo: fontawesome/brands/github
+  features:
+    - navigation.top
+    - header.autohide
+  font: false
+repo_url: https://github.com/YiVal/YiVal
+repo_name: YiVal/YiVal
+extra:
+  homepage: https://yival.io
+
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - extra
+  - toc:
+      permalink: true
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.caret
+  - pymdownx.keys
+  - pymdownx.magiclink
+  - pymdownx.mark
+  - pymdownx.snippets
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+plugins:
+  - search:
+      lang:
+        - en
+        - ja
+  # - mkdocstrings:
+  #     watch:
+  #       - src
+  #     handlers:
+  #       python:
+  #         paths: [src]
+  #         import:
+  #           - https://docs.python.org/3/objects.inv
+  - macros
+  - git-revision-date-localized:
+      type: timeago
+      fallback_to_build_date: true