Merge pull request #30 from chkware/feature/document-version

Feature: document version

Author: 0hsn

docs/00-home.md

@@ -0,0 +1,42 @@
+---
+slug: /
+title: Home
+hide_title: true
+---
+
+![chkware | Test management for api era](./assets/github-readme-01.png)
+
+[![PyPI version](https://badge.fury.io/py/chk.svg)](https://badge.fury.io/py/chk)
+[![Python 3.8](https://img.shields.io/badge/python-3.10-red.svg)](https://www.python.org/downloads/release/python-3102/)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/chkware.svg?style=social&label=Follow%20%40chkware)](https://twitter.com/chkware)
+> Test management for API era.
+
+### Introduction
+
+API tests management is not easy to develop, and maintain. It requires multitude of knowledge of programming libraries, business scenarios, infrastructure details, etc - unless you use ***chkware***.
+
+***chkware*** (pronounced as */check:ware/*) helps you write accurate, robust, and expressive feature tests for your API in less time.
+ 
+Read [more value propositions](introduction) here. Find [changelog](changelog) here.
+
+### Setup
+
+With [**Python 3.10**](https://www.python.org/downloads/) and [**Pipx**](https://pypa.github.io/pipx/installation/#install-pipx) preinstalled, run following in your terminal to get ***chkware*** installed.
+
+```bash
+$ python -m pipx install chk
+```
+
+Jump to the [setup guide](setup) for different ways to install ***chkware***.
+
+### Usage
+
+[Get started](quick-start) quickly here.
+Find [More examples](examples) here
+
+### Contribute
+
+Read [contribution guide](https://github.com/chkware/cli/blob/971e7400848f26f9f8d2be5fa9eef5fa80a6ded0/docs/CONTRIBUTING.md) and [code of conduct](https://github.com/chkware/cli/blob/971e7400848f26f9f8d2be5fa9eef5fa80a6ded0/docs/CODE_OF_CONDUCT.md) to start contributions.
+
+---
+Licensed under [MPL v2.0](https://www.mozilla.org/en-US/MPL/2.0/) | Follow [@chkware](https://twitter.com/chkware) on Twitter | [`chk` project](https://pypi.org/project/chk/) on PyPi

docs/01-introduction.md

@@ -1,7 +1,5 @@
 ---
-slug: /
 title: Introduction
-hide_title: true
 ---
 
 ![chkware | Test management for api era](./assets/github-hero-01.png)
@@ -50,3 +48,17 @@ In practical cases, software testers / QAs, developers, PM/POs, are the people w
 - This project is particularly helpful if you are developing an API oriented project.
 - Test websites or web interfaces are not in the project focus for now.
 - Also, seeding data, validating data in DB is out of this project scope for now.
+
+---
+
+### Platform support
+
+This tool is tested to run on **Linux**, **Windows**, and **macOS** platform.
+
+There is no native binary dependency, therefore it is expected on all the platform where supported Python version works. Please create an issue, if you need additional platform support.
+
+---
+
+### Stability
+
+Current stability for this tool is _Alpha_.

docs/02-setup.md

@@ -1,6 +1,5 @@
 ---
 title: Setup
-hide_title: true
 ---
 
 ### Installation
@@ -69,17 +68,3 @@ $ pipx upgrade chk
 ```
 
 Otherwise, if **pip** was used to install then same process given above should work for upgrade as well.
-
----
-
-### Platform support
-
-This tool is tested to run on **Linux**, **Windows**, and **macOS** platform.
-
-There is no native binary dependency, therefore it is expected on all the platform where supported Python version works. Please create an issue, if you need additional platform support.
-
----
-
-### Stability
-
-Current stability for this tool is _Alpha_.

docs/03-quick-start.md

@@ -1,6 +1,5 @@
 ---
 title: Quick Start
-hide_title: true
 ---
 
 To quickly start, let's try something live online.. [REQ|RES](https://reqres.in) is a hosted demo REST api service. Let's call a simple API endpoint from here.

docs/04-examples.md

@@ -1,6 +1,5 @@
 ---
 title: Examples
-hide_title: true
 ---
 
 :::note

docs/05-reference.md

@@ -1,6 +1,5 @@
 ---
 title: Reference
-hide_title: true
 ---
 
 :::note
@@ -15,7 +14,7 @@ This page describes some key concepts before you use **chkware**. There are two
 1. The command line tool that you can run as `chk http`
 2. The test specification files: those you write in YAML, have extension `.chk`.
 
-### Test specifications
+### Specification files
 
 Test specification files are written in YAML, having file extension `.chk`. So, before you start writing any 
 specs, you should have a proper introduction to YAML, if you do not have already. Here is a fine
@@ -25,6 +24,9 @@ so these files do not make you confuse in typical project layout.
 > In the future evolution path of **chkware** we are going to introduce more and more specification 
 > options and specification types and versions.
 
+
+### Http specification
+
 Let’s get introduced to the Http specification format supported by **chkware**. The Http specification 
 format is how anyone express a Http request. Following is the full reference to write 
 Http specification file.