Skip to content

Commit

Permalink
chore(guides): rename recipes to guides
Browse files Browse the repository at this point in the history
  • Loading branch information
James Singleton committed Mar 2, 2021
1 parent 8f97817 commit 9a5425a
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 15 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
[code-of-conduct-doc]: ./CODE_OF_CONDUCT.md

[api-doc]: ./docs/api/README.md
[recipes-doc]: ./docs/recipes/README.md
[best-practices-doc]: ./docs/recipes/BestPractices.md
[guides-doc]: ./docs/guides/README.md
[best-practices-doc]: ./docs/guides/BestPractices.md

<h1 align="center">
<img src="./one-service-worker.png" alt="one-service-worker - One Amex" width="50%" />
Expand Down Expand Up @@ -51,12 +51,12 @@ Want to get paid for your contributions to `@americanexpress/one-service-worker`

## 📚 Documentation

### **Recipes**
### **Guides**

We have an assortment of recipes and guides to help out with use cases
We have an assortment of guides to help out with use cases
and usage patterns we recommend with the library:

[**👉 Check out the various recipes and guides 👈**][recipes-doc]
[**👉 Check out the various guides 👈**][guides-doc]

### **API**

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/Analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!--ONE-DOCS-HIDE start-->
[👈 Go to `README`](../../README.md)

[👆 Back to `Recipes`](./README.md)
[👆 Back to `Guides`](./README.md)
<!--ONE-DOCS-HIDE end-->

### Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/Basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!--ONE-DOCS-HIDE start-->
[👈 Go to `README`](../../README.md)

[👆 Back to `Recipes`](./README.md)
[👆 Back to `Guides`](./README.md)
<!--ONE-DOCS-HIDE end-->

## 📖 Table of Contents
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/BestPractices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<!--ONE-DOCS-HIDE start-->
[👈 Go to `README`](../../README.md)

[👆 Back to `Recipes`](./README.md)
[👆 Back to `Guides`](./README.md)
<!--ONE-DOCS-HIDE end-->

## 📖 Table of Contents
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/Cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<!--ONE-DOCS-HIDE start-->
[👈 Go to `README`](../../README.md)

[👆 Back to `Recipes`](./README.md)
[👆 Back to `Guides`](./README.md)
<!--ONE-DOCS-HIDE end-->

With the [`caches` CacheStorage][cache-storage-api] and [`cache` Cache][cache-api], we can create and manage
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/Patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!--ONE-DOCS-HIDE start-->
[👈 Go to `README`](../../README.md)

[👆 Back to `Recipes`](./README.md)
[👆 Back to `Guides`](./README.md)
<!--ONE-DOCS-HIDE end-->

## Scope based service worker scripts
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[👈 Return to README](../../README.md)
<!--ONE-DOCS-HIDE end-->

# 👩‍🍳 Recipes
# 👩‍🍳 Guides

* [Analytics](./Analytics.md)
* [Basics](./Basics.md)
Expand All @@ -13,4 +13,4 @@
* [With React](./WithReact.md)
* [Testing A Service Worker](./Testing.md)

[☝️ Return To Top](#-recipes)
[☝️ Return To Top](#-guides)
2 changes: 1 addition & 1 deletion docs/guides/Testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<!--ONE-DOCS-HIDE start-->
[👈 Go to `README`](../../README.md)

[👆 Back to `Recipes`](./README.md)
[👆 Back to `Guides`](./README.md)
<!--ONE-DOCS-HIDE end-->

## 📖 Table of Contents
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/WebPush.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<!--ONE-DOCS-HIDE start-->
[👈 Go to `README`](../../README.md)

[👆 Back to `Recipes`](./README.md)
[👆 Back to `Guides`](./README.md)
<!--ONE-DOCS-HIDE end-->

**Before starting, take note of the script names**
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/WithReact.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!--ONE-DOCS-HIDE start-->
[👈 Go to `README`](../../README.md)

[👆 Back to `Recipes`](./README.md)
[👆 Back to `Guides`](./README.md)
<!--ONE-DOCS-HIDE end-->

It can be beneficial to register a service worker as early as possible during app start.
Expand Down

0 comments on commit 9a5425a

Please sign in to comment.