From 046cc20f71dcfab2c50f3874a297e39ba73fd1dd Mon Sep 17 00:00:00 2001
From: Pranav Raj Sreepuram
Date: Wed, 9 Oct 2019 17:55:33 +0530
Subject: [PATCH] Update documentation to include page title and slug
---
docs/README.md | 14 ++++-----
docs/_sidebar.md | 9 ------
docs/contributing.md | 5 +++-
docs/contributors.md | 5 +++-
docs/development/environment-setup/ubuntu.md | 5 +++-
.../development/project-setup/dependencies.md | 5 ++++
.../project-setup/environment-variables.md | 5 ++++
docs/development/project-setup/errors.md | 5 ++++
docs/index.html | 30 +++----------------
docs/styles.css | 11 -------
10 files changed, 36 insertions(+), 58 deletions(-)
delete mode 100644 docs/_sidebar.md
delete mode 100644 docs/styles.css
diff --git a/docs/README.md b/docs/README.md
index 76d7fd89f..a7bf348f0 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,10 +1,6 @@
-
-
+---
+title: 'Documentation'
+path: '/docs'
+---
-
Opensource alternative to Intercom, Zendesk, Drift, Crisp etc.
-
-![ChatUI progess](.github/dashboard-screen.png)
-
-*Chatwoot* © 2017-2019, ThoughtWoot Inc - Released under the MIT License.
-
-
+This guide will help you get started with Chatwoot!
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
deleted file mode 100644
index ff7e6b1e4..000000000
--- a/docs/_sidebar.md
+++ /dev/null
@@ -1,9 +0,0 @@
-
-
-* [Home](/)
-* [Development Guide](development/environment-setup/ubuntu.md)
-* [Project Dependencies](development/project-setup/dependencies.md)
-* [Environment Variables](development/project-setup/environment-variables.md)
-* [Common Errors](development/project-setup/errors.md)
-* [Contributing Guide](contributing.md)
-* [Contributors](contributors.md)
diff --git a/docs/contributing.md b/docs/contributing.md
index 296b5fe09..9dababf41 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -1,4 +1,7 @@
-# Chatwoot Contributing Guide
+---
+path: "/docs/contributing-guide"
+title: "Contributing Guide"
+---
Thanks for taking interest in contributing to Chatwoot source code. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
diff --git a/docs/contributors.md b/docs/contributors.md
index d25f149a6..10674649e 100644
--- a/docs/contributors.md
+++ b/docs/contributors.md
@@ -1,4 +1,7 @@
-### Contributors
+---
+path: "/docs/contributors"
+title: "Contributors"
+---
diff --git a/docs/development/environment-setup/ubuntu.md b/docs/development/environment-setup/ubuntu.md
index 3e0d652d7..47878a5b2 100644
--- a/docs/development/environment-setup/ubuntu.md
+++ b/docs/development/environment-setup/ubuntu.md
@@ -1,4 +1,7 @@
-## Ubuntu
+---
+path: "/docs/installation-guide-ubuntu"
+title: "Ubuntu installation guide"
+---
Open a terminal and run the following commands
diff --git a/docs/development/project-setup/dependencies.md b/docs/development/project-setup/dependencies.md
index a84e2953f..7302e6801 100644
--- a/docs/development/project-setup/dependencies.md
+++ b/docs/development/project-setup/dependencies.md
@@ -1,3 +1,8 @@
+---
+path: "/docs/dependencies"
+title: "Project Dependencies"
+---
+
### Install Ruby dependencies
Use the following command to install ruby dependencies.
diff --git a/docs/development/project-setup/environment-variables.md b/docs/development/project-setup/environment-variables.md
index 563239aa0..d8627e474 100644
--- a/docs/development/project-setup/environment-variables.md
+++ b/docs/development/project-setup/environment-variables.md
@@ -1,3 +1,8 @@
+---
+path: "/docs/environment-variables"
+title: "Environment Variables"
+---
+
### Setup environment variables
Copy `database` and `application` variables to the correct location.
diff --git a/docs/development/project-setup/errors.md b/docs/development/project-setup/errors.md
index 2e0aa0d80..a9b68c63f 100644
--- a/docs/development/project-setup/errors.md
+++ b/docs/development/project-setup/errors.md
@@ -1,3 +1,8 @@
+---
+path: "/docs/common-errors"
+title: "Common Errors"
+---
+
### Errors you might encounter while setting up the project
#### ArgumentError: invalid uri scheme
diff --git a/docs/index.html b/docs/index.html
index e1976b8fa..9d97246c5 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,26 +1,4 @@
-
-
-
-
- Chatwoot | Opensource alternative to Intercom, Zendesk, Drift, Crisp.
-
-
-
-
-
-
-
-
-
-
-
-
+
+
diff --git a/docs/styles.css b/docs/styles.css
deleted file mode 100644
index 08d7cdbe1..000000000
--- a/docs/styles.css
+++ /dev/null
@@ -1,11 +0,0 @@
-html, body {
- font-family: Avenir, -apple-system,system-ui,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif
-}
-
-.app-name-link img {
- max-width: 60%;
-}
-
-.markdown-section pre > code {
- font-family: Monaco;
-}