diff --git a/README.md b/README.md index 7abeaa1..7b44e25 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Overview | docs | [![docs](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test_docs.yml/badge.svg)][docs_link] | -|:-------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| :-----------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **build** | [![build](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/build.yml/badge.svg)][build_link] | | **tests** | [![test](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test.yml/badge.svg)][test_link] | | **page deployment** | [![page deployment](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/pages/pages-build-deployment/badge.svg)][deploy_link] | diff --git a/docs_theme/contributing.md b/docs_theme/contributing.md index fb188b8..621a4c7 100644 --- a/docs_theme/contributing.md +++ b/docs_theme/contributing.md @@ -8,6 +8,9 @@ When [reporting a bug](https://github.com/FedericoTartarini/jsthermalcomfort/iss - Detailed steps to reproduce the bug. ## Documentation improvements + +If you find any issue in our online [documentation](https://federicotartarini.github.io/jsthermalcomfort/) please open an [issue](https://github.com/FedericoTartarini/jsthermalcomfort/issues). + jsthermalcomfort could always use more documentation, whether as part of the official jsthermalcomfort docs, in JSDocs, or even on the web in blog posts, articles, and such. ## Feature requests and feedback @@ -80,7 +83,7 @@ For merging, you should: ### Documentation We are using [JSDoc](https://jsdoc.app/) and [documentation.js](https://github.com/documentationjs/documentation) to automatically build the documentation. -### To add a function +### To add a function 1. Add a file under `src/models/` with the name of the function/model and document it. 2. Add any related functions that are used by your function either in `src/utilities/utilities.js` or `src/psychrometrics/`. See existing code as example. - In order to add a new function/API to the library you should mark that function as `@public`, add it to its corresponding category, for example for models you should do `@memberof models`, and lastly you should give it a proper name for the documentation with `@docname`, for example: `@docname Clothing prediction`. It is important to note that you should also add the `@public` tag to any types the function exposes/uses. diff --git a/docs_theme/examples.md b/docs_theme/examples.md index c2ec602..79a6428 100644 --- a/docs_theme/examples.md +++ b/docs_theme/examples.md @@ -1,4 +1,4 @@ ## [Examples](https://github.com/FedericoTartarini/jsthermalcomfort/tree/main/docs/examples) files on how to use some of the functions Here is a list of examples running in the browser: -- [PHS](/jsthermalcomfort/examples/phs.html) \ No newline at end of file +- [PHS](/docs/examples/phs.html) \ No newline at end of file diff --git a/docs_theme/installation.md b/docs_theme/installation.md index 450c218..b116212 100644 --- a/docs_theme/installation.md +++ b/docs_theme/installation.md @@ -2,8 +2,7 @@ npm install jsthermalcomfort ``` - -if you want to use jsthermalcomfort package without installing it on your local machine, you can import with: +If you want to use jsthermalcomfort package without installing it on your local machine, you can import with: [`https://cdn.jsdelivr.net/gh/FedericoTartarini/jsthermalcomfort/lib/esm/`](https://cdn.jsdelivr.net/gh/FedericoTartarini/jsthermalcomfort/lib/esm/) diff --git a/docs_theme/overview.md b/docs_theme/overview.md index 8b2f76c..7510fac 100644 --- a/docs_theme/overview.md +++ b/docs_theme/overview.md @@ -1,23 +1,26 @@ -|docs|[![docs](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test_docs.yml/badge.svg)][docs_link]| -|:---:|:---| -|**build**|[![build](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/build.yml/badge.svg)][build_link]| -|**tests**|[![test](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test.yml/badge.svg)][test_link]| -|**page deployment**|[![page deployment](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/pages/pages-build-deployment/badge.svg)][deploy_link]| -|**snyk security**|[![synk](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/snyk.yml/badge.svg)][synk_link]| -|**license**|[![license](https://custom-icon-badges.demolab.com/github/license/denvercoder1/custom-icon-badges?logo=law)](https://github.com/FedericoTartarini/jsthermalcomfort/blob/main/LICENSE)| -|**npm version**|[![npm](https://img.shields.io/npm/v/jsthermalcomfort?style=plastic&logo=npm&logoColor=rgb)][npm_link]| +| docs | [![docs](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test_docs.yml/badge.svg)][docs_link] | +|:-------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **build** | [![build](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/build.yml/badge.svg)][build_link] | +| **tests** | [![test](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test.yml/badge.svg)][test_link] | +| **page deployment** | [![page deployment](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/pages/pages-build-deployment/badge.svg)][deploy_link] | +| **snyk security** | [![synk](https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/snyk.yml/badge.svg)][synk_link] | +| **license** | [![license](https://custom-icon-badges.demolab.com/github/license/denvercoder1/custom-icon-badges?logo=law)](https://github.com/FedericoTartarini/jsthermalcomfort/blob/main/LICENSE) | +| **npm version** | [![npm](https://img.shields.io/npm/v/jsthermalcomfort?style=plastic&logo=npm&logoColor=rgb)][npm_link] | +Package to calculate thermophysiological, thermal comfort, thermal stress indices, in JavaScript. -Package to calculate several thermal comfort indices (e.g. PMV, PPD, SET, adaptive) and convert physical variables. - -Please cite us if you use this package: [Tartarini, F., Schiavon, S., 2020. pythermalcomfort: A Python package for thermal comfort research. SoftwareX 12, 100578. https://doi.org/10.1016/j.softx.2020.100578](https://www.sciencedirect.com/science/article/pii/S2352711020302910) +Please cite us if you use this package: [Tartarini, F., Schiavon, S., 2020. pythermalcomfort: A Python package for thermal comfort research. SoftwareX 12, 100578. https://doi.org/10.1016/j.softx.2020.100578](https://www.sciencedirect.com/science/article/pii/S2352711020302910) - Free software: MIT license -- Authors: [Omar Jesus Acuache Briceno](https://www.linkedin.com/in/omar-acuache), [Ruoshui Chen](https://github.com/ChristinChen233), [Jingyu Lu](https://github.com/Lu-Whale), [Yuchen Mu](https://github.com/YuchenMu), [Jordan Ocokoljic](https://github.com/JordanOcokoljic), [Santiago Zaldivar del Alba​](https://github.com/szaldivar) +- Authors: [Omar Jesus Acuache Briceno](https://www.linkedin.com/in/omar-acuache), [Ruoshui Chen](https://github.com/ChristinChen233), [Jingyu Lu](https://github.com/Lu-Whale), [Yuchen Mu](https://github.com/YuchenMu), [Jordan Ocokoljic](https://github.com/JordanOcokoljic), [Santiago Zaldivar del Alba​](https://github.com/szaldivar), [Federico Tartarini](https://www.linkedin.com/in/federico-tartarini/), [Stefano Schiavon](https://www.linkedin.com/in/stefanoschiavon/), [Ollie Jay](https://www.linkedin.com/in/ollie-jay-793a1b11/) + +[docs_link]: https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test_docs.yml +[build_link]: https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/build.yml +[test_link]: https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test.yml +[deploy_link]: https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/pages/pages-build-deployment +[synk_link]: https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/snyk.yml +[npm_link]: https://www.npmjs.com/package/jsthermalcomfort + +# Documentation -[docs_link]:https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test_docs.yml -[build_link]:https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/build.yml -[test_link]:https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/test.yml -[deploy_link]:https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/pages/pages-build-deployment -[synk_link]:https://github.com/FedericoTartarini/jsthermalcomfort/actions/workflows/snyk.yml -[npm_link]:https://www.npmjs.com/package/jsthermalcomfort \ No newline at end of file +[https://federicotartarini.github.io/jsthermalcomfort/](https://federicotartarini.github.io/jsthermalcomfort/) \ No newline at end of file diff --git a/package.json b/package.json index 9da6492..e5466f8 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "jsthermalcomfort", "version": "0.1.4", - "description": "A JavaScript package to calculate thermal comfort indices (e.g., Predicted Mean Vote, Standard Effective Temperature, Predicted Heat Strain).", + "description": "A JavaScript package to calculate thermophysiological, thermal comfort, thermal stress indices", "type": "module", "files": [ "lib" @@ -42,7 +42,7 @@ "bugs": { "url": "https://github.com/FedericoTartarini/jsthermalcomfort/issues" }, - "homepage": "https://github.com/FedericoTartarini/jsthermalcomfort#readme", + "homepage": "https://federicotartarini.github.io/jsthermalcomfort/", "devDependencies": { "documentation": "^14.0.2", "github-slugger": "^2.0.0",