Skip to content

Commit

Permalink
feat: move to using GitHub pages for the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sf-v committed May 11, 2023
1 parent 996ea74 commit 2a7d0a2
Show file tree
Hide file tree
Showing 123 changed files with 3,431 additions and 6,154 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ __benchmarks_results__
# Builds
packages/**/build/
packages/**/dist/
docs/dist/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ that](.github/CONTRIBUTING.md) too.

This project is licensed under the [MIT license](LICENSE).

[best introduction]: docs/content/docs/introduction.md
[best introduction]: https://opensource.salesforce.com/best/#/introduction/
[build icon]: https://github.com/salesforce/best/actions/workflows/tests.yml/badge.svg
[build url]: https://github.com/salesforce/best/actions/workflows/tests.yml
[getting started]: docs/content/docs/getting-started.md
[getting started]: https://opensource.salesforce.com/best/#/getting-started/
File renamed without changes.
1 change: 0 additions & 1 deletion docs/Procfile

This file was deleted.

97 changes: 97 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Best

**Delightful Benchmarking & Performance Testing**

[Learn the fundamentals of Best](introduction/) and begin accurately
measuring your code's performance.

* Easy to Write

Benchmarks are easy to write with a simple set of familiar primitives
so you don't have to learn a whole new framework.

* Anywhere and Anytime

You can run, compare, and diff any change locally and on dedicated
hardware. This lets you compare any version in any browser you desire.

* Simple Automation

Best allows you to set up one set of shared hardware so individual
teams don't have to maintain their own infrastructure.

## Getting Started with Best

Best allows you to write benchmarks 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. Ready to
jump in? Check out the [Guide](introduction/) to read about how to get
started!

```js
import fib from '../fib';

describe('js-execution', () => {
benchmark('fibonacci 15', () => {
run(() => {
return fib(15);
})
})

benchmark('fibonacci 38', () => {
run(() => {
return fib(38);
})
})
})
```

## Why Use Best?

### Reproducible Results

Best is designed to run on dedicated hardware so your benchmarks run
in the same environment every time. We recommend this so your results
are not affected by inconsistent environments.

The Best Hub and Agent model works great for implementing this.
Learn more in [Setting Up a Best Hub](running-remotely/).

![Best Compare Stats](_assets/compare_stats.png)

### Expressive Metrics

Best comes with the ability to measure all the metrics you might want
to know. Learn more in [Expressive Metrics](introduction/#expressive-metrics).

* `aggregate` - The total time your benchmark took to run.
* `script` - The time it took to evaluate your benchmark code.
* `paint` - If your benchmark involves the DOM, Best measures how much
time the browser spends on painting.
* `layout` - If your benchmark involves the DOM, Best measures how much
time the browser spends on layouts.

![Best Example Run](_assets/lwc_example_terminal.png)

### GitHub Integration

If your team uses GitHub, you can create a GitHub app that integrates
Best into your pull request workflow.

Best comes with a built-in GitHub bot that creates
[checks](https://help.github.com/en/articles/about-status-checks) and
comments when a pull request causes a significant performance change.
Learn more in [Integrating Best with GitHub](github-integration/).

![Best GitHub Comment](_assets/github_comment.png)

### The Best Front End

Best comes with a front-end dashboard to monitor your benchmarks
by commit over time. This allows you to pinpoint which commits cause
performance improvements and regressions.

The front end allows you to view all your projects and benchmarks in
one place. Learn more in [Enabling The Best Front End](frontend/)

![Best Frontend Example](_assets/frontend_example.png)
Binary file added docs/_assets/compare_stats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/frontend_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/github_comment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added docs/_assets/lwc_example_terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_assets/scripts.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/_assets/styles.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2a7d0a2

Please sign in to comment.