KumiSystems/Chatwoot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update documentation to include page title and slug

Browse source
This commit is contained in:
Pranav Raj Sreepuram 2019-10-09 17:55:33 +05:30
parent 0621fa66e4
commit 046cc20f71
10 changed files with 36 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/README.md
View file

@ -1,10 +1,6 @@
<p align="center">
<img src=".github/woot-logo.svg" alt="Woot-logo" width="240">
---
title: 'Documentation'
path: '/docs'
---
<div align="center">Opensource alternative to Intercom, Zendesk, Drift, Crisp etc.</div>
![ChatUI progess](.github/dashboard-screen.png)
<div align="center">*Chatwoot* &copy; 2017-2019, ThoughtWoot Inc - Released under the MIT License.
</div>
</p>
This guide will help you get started with Chatwoot!

9
docs/_sidebar.md
View file

@ -1,9 +0,0 @@
<!-- docs/_sidebar.md -->
* [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)

5
docs/contributing.md
View file

@ -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:

5
docs/contributors.md
View file

@ -1,4 +1,7 @@
### Contributors
---
path: "/docs/contributors"
title: "Contributors"
---
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->

5
docs/development/environment-setup/ubuntu.md
View file

@ -1,4 +1,7 @@
## Ubuntu
---
path: "/docs/installation-guide-ubuntu"
title: "Ubuntu installation guide"
---
Open a terminal and run the following commands

5
docs/development/project-setup/dependencies.md
View file

@ -1,3 +1,8 @@
---
path: "/docs/dependencies"
title: "Project Dependencies"
---
### Install Ruby dependencies
Use the following command to install ruby dependencies.

5
docs/development/project-setup/environment-variables.md
View file

@ -1,3 +1,8 @@
---
path: "/docs/environment-variables"
title: "Environment Variables"
---
### Setup environment variables
Copy `database` and `application` variables to the correct location.

5
docs/development/project-setup/errors.md
View file

@ -1,3 +1,8 @@
---
path: "/docs/common-errors"
title: "Common Errors"
---
### Errors you might encounter while setting up the project
#### ArgumentError: invalid uri scheme

30
docs/index.html
View file

@ -1,26 +1,4 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Chatwoot | Opensource alternative to Intercom, Zendesk, Drift, Crisp.</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
name: 'Chatwoot',
repo: 'chatwoot/chatwoot',
loadSidebar: true,
subMaxLevel: 4,
notFoundPage: true,
logo: '.github/woot-logo.svg'
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</body>
</html>
<script>
window.location.href = 'https://www.chatwoot.com/docs'
</script>

11
docs/styles.css
View file

@ -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;
}