feat: Documentation! (#175)

* docs: proof all homepage and guide
salesforce · Sep 3, 2019 · e4f9f72 · e4f9f72
1 parent de23d70
commit e4f9f72
Show file tree

Hide file tree

Showing 47 changed files with 950 additions and 521 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -19,7 +19,7 @@ Please check if your PR fulfills the following requirements:
 * Docs have been added / updated (for bug fixes / features)
 
 ### PR Title
-LWC PR title follows [conventional commit](../CONTRIBUTING.md#create-a-pull-request) format and is automatically validated by our CI.
+Your PR title should following the format below and is automatically validated by our CI.
 ```shell
 ex:
 commit-type(optional scope): commit description. ( NOTE: space between column and the message )

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/README.md b/README.md
@@ -1,57 +1,28 @@
-# Best
+<h1 align="center">🏆 Best Performance Benchmarks 🏆</h1>
 
-Delightful JavaScript performance benchmarking. It's like Jest but for benchmarking ;)
+[![circleci badge](https://circleci.com/gh/salesforce/best/tree/master.svg)](https://circleci.com/gh/salesforce/best/tree/master) [![npm version](https://badge.fury.io/js/best.svg)](https://badge.fury.io/js/best) [![best badge](https://img.shields.io/badge/Performance%20By-Best-5100B9?labelColor=lightgrey)](https://perf.bestjs.dev)
 
-[![asciicast](https://asciinema.org/a/158780.png)](https://asciinema.org/a/158780)
-
-## Getting Started
-
-This is a work in progress. Feedback is welcome.
-
-### Instructions to give it a run:
-
-Install dependencies:
+Best allows you to write benchmarks in the same way you write unit tests. This allows you to integrate Best into your CI workflow to create a consistent picture of your code's performance over time.
 
-```bash
-yarn install
-```
+**Reproducible Results**: Best is designed to run on dedicated hardware, this means that you are running your benchmarks in the same environment everytime.
 
-Watch/build projects for development:
+**Expressive Metrics**: Best comes packed with ability to measure all the types of metrics you might want to know.
 
-```bash
-yarn watch
-```
+**GitHub Integration**: If your team uses GitHub then you can easily create a GitHub App so that you can integrate Best into your Pull Request workflow.
 
-Go to the example repo:
+**The Best Frontend**: Best comes built-in with a frontend dashboard that allows you to monitor your benchmarks over the time with each commit.
 
-```bash
-cd examples/simple_benchmark/
-```
-
-Run the benchmark
-
-```bash
-yarn perf --interactions 3
-```
-
-Be delighted!
+## Getting Started
+Ready to jump in? We recommend starting with [The "Best" Manifesto][best introduction] first, and then once you have a solid understanding of how Best works, checking out the [Developer Guide][getting started] to read about how to get started!
 
-### Example benchmark test
+## Demo
+[![asciicast](https://asciinema.org/a/158780.png)](https://asciinema.org/a/158780)
 
-You can find an example benchmark under `examples/simple_benchmark/src/simple-item/__benchmarks__`
+## Contributing
+To get setup to help contribute to Best, we have a [guide for that](.github/CONTRIBUTING.md) too.
 
-```javascript
-import Ctor from 'simple-item';
-import { createElement } from 'engine';
+## License
+This project is licensed under the [MIT license](LICENSE).
 
-benchmark('create_and_render', () => {
-    let element;
-    run(() => {
-        element = createElement('simple-item', { is: Ctor });
-        document.body.appendChild(element);
-    });
-    after(() => {
-        return element && element.parentElement.removeChild(element);
-    });
-});
-```
+[best introduction]: https://bestjs.dev/guide/introduction
+[getting started]: https://bestjs.dev/guide/getting-started
diff --git a/docs/Procfile b/docs/Procfile
@@ -0,0 +1 @@
+web: yarn start
diff --git a/docs/config.js b/docs/config.js
@@ -2,8 +2,13 @@ module.exports = {
     // Ordered list of docs what will be loaded
     docs: {
         pages: [
-            'install',
             'introduction',
+            'getting-started',
+            'running-remotely',
+            'continuous-integration',
+            'github-integration',
+            'frontend',
+            'configuration'
         ],
     },
     blog: {

diff --git a/docs/content/blog/welcome_to_best.md b/docs/content/blog/welcome_to_best.md
@@ -1,6 +1,6 @@
 ---
 title: Welcome to Best
-subtitle: Its finally here!
+subtitle: It's finally here!
 author: LWC Team
 created_at: May 26, 2019
 ---