Skip to content

Commit 6597ad4

Browse files
committed
Update readme
1 parent e177e7b commit 6597ad4

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# WooCommerce Memberships REST API documentation
1+
## WooCommerce Memberships REST API documentation
22

3-
Official repository for the documentation of the [WooCommerce Memberships](https://woocommerce.com/products/woocommerce-memberships/) REST API.
3+
_Official repository for the documentation of the [WooCommerce Memberships](https://woocommerce.com/products/woocommerce-memberships/) REST API._
44

55
[Follow this link](https://skyverge.github.io/woocommerce-memberships-rest-api-docs/) to read the **REST API documentation**.
66

77
> If you are looking for the general **plugin documentation**, [please follow this link](https://docs.woocommerce.com/document/woocommerce-memberships/).
88
9-
## Contributing
9+
### Contributing
1010

1111
You can contribute to this documentation by:
1212

@@ -15,9 +15,9 @@ You can contribute to this documentation by:
1515

1616
> Please **do not submit feature requests or support requests for the REST API** here. You can use the [WooIdeas board](http://ideas.woocommerce.com/forums/133476-woocommerce?category_id=125014) or [Contact SkyVerge support](https://www.skyverge.com/support/).
1717
18-
## Running locally
18+
### Running locally
1919

20-
### Natively
20+
#### Natively
2121

2222
```shell
2323
bundle install
@@ -31,7 +31,7 @@ Then, to test changes locally run:
3131
bundle exec middleman server
3232
```
3333

34-
### Via Docker
34+
#### Via Docker
3535

3636
1. Build the docker image:
3737
```shell
@@ -49,15 +49,21 @@ To build your sources while the container is running, run:
4949
docker exec -it docs /bin/bash -c "bundle exec middleman build"
5050
```
5151

52-
## Updating pages
52+
### Updating pages
5353

5454
This project uses [Slate](https://github.com/lord/slate) for building the documentation pages.
5555

5656
Follow [Slate readme](https://github.com/lord/slate/blob/master/README.md) and [wiki](https://github.com/lord/slate/wiki) for instructions on how to edit files and make changes.
5757

58-
## Deploying an update
58+
### Deploying an update
5959

60-
After pushing changes and you are ready to deploy use the script:
60+
#### GitHub Action
61+
62+
A `deploy` GitHub action is triggered automatically when changes are pushed to `main` or `master` branches. No manual action is normally required.
63+
64+
#### Deploy script
65+
66+
If the GitHub action fails, after pushing changes, you can deploy using the script:
6167

6268
```shell
6369
bash deploy.sh

0 commit comments

Comments
 (0)