From 875f003855e30c8a95c5fbfa9e6ac1d08c2d726c Mon Sep 17 00:00:00 2001 From: j-milkovits Date: Wed, 9 Aug 2023 08:39:27 +0200 Subject: [PATCH 1/2] link README docs link to actual documentation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bebc41a8..084715cf 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ display(variable, target="folium") ## Documentation -[Documentation](https://py4js.github.io/pyscript-react) +[Documentation](https://py4js.github.io/pyscript-react/docs/intro) `we are working on it... 🐢` From 5a760dc654deff6e3bfc369518dfaedeec3f7789 Mon Sep 17 00:00:00 2001 From: j-milkovits Date: Wed, 9 Aug 2023 08:42:08 +0200 Subject: [PATCH 2/2] fix typos and grammar in docs --- documentation/docs/advanced/specific-module-installation.mdx | 2 +- documentation/docs/get-started/concept.mdx | 2 +- documentation/docs/intro.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/docs/advanced/specific-module-installation.mdx b/documentation/docs/advanced/specific-module-installation.mdx index c6418417..4b0a81e8 100644 --- a/documentation/docs/advanced/specific-module-installation.mdx +++ b/documentation/docs/advanced/specific-module-installation.mdx @@ -5,7 +5,7 @@ title: Specific module installation # Installation of the specific module type -By default, PyScript-React uses [UMD](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/global-plugin-d-ts.html#umd) version of code. In this package we can access diffrent module types. For example, if we would like to use [ESM](https://tc39.es/ecma262/#sec-modules), we can add to import a post-fix after the library name. +By default, PyScript-React uses [UMD](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/global-plugin-d-ts.html#umd) version of code. In this package we can access different module types. For example, if we would like to use [ESM](https://tc39.es/ecma262/#sec-modules), we can add to import a post-fix after the library name. Example: diff --git a/documentation/docs/get-started/concept.mdx b/documentation/docs/get-started/concept.mdx index 3dd3aa4b..9eda8442 100644 --- a/documentation/docs/get-started/concept.mdx +++ b/documentation/docs/get-started/concept.mdx @@ -5,7 +5,7 @@ title: Concept # Concept -PyScript-React builds to diffrent module types. By default it uses [UMD](https://www.npmjs.com/package/pyscript-react-umd). +PyScript-React builds to different module types. By default it uses [UMD](https://www.npmjs.com/package/pyscript-react-umd). Folder structure diff --git a/documentation/docs/intro.mdx b/documentation/docs/intro.mdx index 05b638e9..f595801a 100644 --- a/documentation/docs/intro.mdx +++ b/documentation/docs/intro.mdx @@ -5,6 +5,6 @@ title: Introduction # Introduction -PyScript-React is a wrapper around [PyScript](https://github.com/pyscript/pyscript) for [React](https://github.com/facebook/react). Idea behind that library is to simplify process to embed PyScript in our React application. +PyScript-React is a wrapper around [PyScript](https://github.com/pyscript/pyscript) for [React](https://github.com/facebook/react). The Idea behind this library is to simplify the process of embedding PyScript in our React application. ## Why PyScript-React?