Updated some documentation pages (#440)

lvcabral · Jan 8, 2025 · f0b9098 · f0b9098
1 parent 2224167
commit f0b9098
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/docs/engine-api.md b/docs/engine-api.md
@@ -2,7 +2,7 @@
 
 The engine worker library has a programmable interface to make it easy to integrate into any web based application.
 
-Check the [documentation](docs/integrating.md) to learn how to start using it. The only pre-requisites are to expose, on the default `document`, a `canvas` object named `display` and a `video` object named `player`, and optionally,  if you want to show the performance statistics, you also need to expose a `div` object named `stats`.
+Check the [documentation](./integrating.md) to learn how to start using it. The only pre-requisites are to expose, on the default `document`, a `canvas` object named `display` and a `video` object named `player`, and optionally,  if you want to show the performance statistics, you also need to expose a `div` object named `stats`.
 
 ## Methods
 

diff --git a/docs/integrating.md b/docs/integrating.md
@@ -16,7 +16,7 @@ $ yarn add brs-engine
 
 This repository provides a sample web application for testing the engine, located under the `browser/` folder, you can download the full example from the [release page](https://github.com/lvcabral/brs-engine/releases) with the libraries already integrated, or you can try the simpler example listed below.
 
-To learn more about the _methods_ and _events_ exposed by the library visit the [API documentation](engine-api.md).
+To learn more about the _methods_ and _events_ exposed by the library visit the [API documentation](./engine-api.md).
 
 **Important Notes:**
 
@@ -48,7 +48,7 @@ If you added a break point (`stop`) in your code, you can also debug using the _
 
 The Roku `registry` data is stored on the browser **Local Storage** and you can inspect it also using the Developer Tools (Application tab).
 
-If your code does show an error in some scenario not listed on the [limitations documentation](docs/limitations.md), feel free to [open an issue](https://github.com/lvcabral/brs-engine/issues).
+If your code does show an error in some scenario not listed on the [limitations documentation](./limitations.md), feel free to [open an issue](https://github.com/lvcabral/brs-engine/issues).
 
 ## Games and Demos
 

diff --git a/docs/publish-package.md b/docs/publish-package.md
@@ -16,7 +16,16 @@
 
 After the package `latest` tag is updated, run this command on your Terminal to make sure the npm badge is up to date:
 
-```shell
+```console
 curl -X PURGE https://camo.githubusercontent.com/8134e08f7ee670486f1e16039625a28fc0dc88f5a667b80535dd630a7a86f0f0/68747470733a2f2f62616467652e667572792e696f2f6a732f6272732d656d752e7376673f7374796c653d666c6174
 { "status": "ok", "id": "8200116-1678720264-342697" }
 ```
+
+## To force update a Tag if needed
+
+```console
+git checkout master
+git pull origin master
+git tag -f v1.0.0
+git push origin -f v1.0.0
+```