Merge pull request #53 from SpringRoll/main

jeremymccurdy-redspace · web-flow · commit c14bae5a056f · 2024-10-11T12:54:39.000-03:00
Main to develop after 3.0.0 release
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,58 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [3.0.0] - 2024-10-11
+## Changed
+- This is a complete rewrite of SpringRoll.io using the [Docusaurus](https://docusaurus.io/) framework.
+- The site now uses React instead of Vue, and is responsive.
+- All example content has been ported over. It's included as part of the `Examples` section. `Game Demo` and `Scale Manager` have also been moved to this section. 
+- All example UI elements have been updated to follow the styles and standards of the new site. Notable updates will be outlined below.
+
+#### Game Demo Changes
+- The game demo has had all of its packages updated. 
+- Implemented `SafeScaleManager`. 
+- The title screen has been updated.
+- Captions styling has been updated.
+- The demo is now displayed using SpringRoll Container instead of just using Bellhop.
+
+#### Color Filter Changes
+- The example image is no longer stretched. 
+
+#### Resize Changes
+- This example now uses the `SafeScaleManager` instead of `ScaleManager`. 
+
+#### Bellhop
+- This example has been simplified to only demonstrate how to use Bellhop without using SpringRoll specific events.
+
+#### Indexed DB
+- The data display table was rewritten and simplified. It was using a built-in Vue component. 
+- The help section below the example now has a horizontal row of tabs instead of vertical.
+- There are new error checks for things that used to silently fail.
+- A few bugs were identified in the SpringRoll IDB implementation. Opening and deleting stores with incorrect version numbers can cause errors. This shouldn't affect most users under normal circumstances, but we've made a ticket to address this.
+
+## Added
+- PBS KIDS branding and a brief write-up about the team’s work on the project have been added to the homepage. 
+
+## Removed
+- API documentation has been removed. 
+- Captions Studio has been removed. It is now part of SpringRoll Studio.
+- The SpringRoll 1 section has been removed. 
+- The GitHub wiki link to SpringRoll 1 documentation has also been removed.
+
+
+## [2.1.0] - 2021-03-04
+## Added
+- This changelog
+- character count for captions and warning when over 40 characters per line
+- caption error reporting
+- Safe Scale Manager demo page
+- Indexed DB demo page under examples/
+
+## Changed
+- Import is changed to allow for individual files rather than whole directories
+- Caption output is no longer an HTML string. Changed to plain text.
+- JSON Preview is now editable and will reflect across the other components
+
diff --git a/README.MD b/README.MD
@@ -1,44 +1,80 @@
-# Website
+The [docs site](http://springroll.io/) has been completely rewritten from the ground up using the [Docusaurus](https://docusaurus.io/) framework. It's a React-based static doc site generator. The layout is responsive and has a dark mode. The new documentation is designed to be more user-friendly, with improved navigation and a better reading experience. 
 
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+All of the documentation for SpringRoll and SpringRoll Container has been added to the new site. This will be where documentation for those repositories will belong. 
 
+At the moment, the documentation is just a direct copy of those repositories. We are planning to re-organize and update the documentation to make it easier to navigate and read.
+
+PBS KIDS branding and a brief write-up about the team’s work on the project have been added to the homepage. 
+
+
+### Ported Content
+All example content has been moved over to the new docs site. It's all included as part of the `Examples` section.  `Game Demo` and `Scale Manager` have also been moved to this section. 
+
+#### Example changes
+###### Game Demo
+- The node packages in the project have all been updated, including SpringRoll.
+- The demo now implements the SpringRoll `SafeScaleManager`, allowing it to scale down to fit smaller screens.
+- The title screen has been updated with the correct capitalization.
+- Captions styling has been updated to match the style used in most PBS KIDS games.
+- The sidebar buttons and game event indicators have been updated to match the new docs site styling and work in dark mode.
+- The demo is now displayed using SpringRoll Container instead of just using Bellhop.
+
+
+###### Speech Synth
+- The example is the same, just with styling from the docs site.
+
+###### Color Filter
+- The example image is no longer stretched. 
+- The rest is the same, just with the new styling.
+
+###### Resize
+- This example now uses the `SafeScaleManager` as the original `ScaleManager` is deprecated. Code examples represent this too.
+- The rest is the same, just with the new styling.
+
+###### Bellhop
+- This example has been simplified to only demonstrate how to use Bellhop without using SpringRoll specific events.
+
+###### Controls
+- The example is the same, just with styling from the docs site.
+
+###### Indexed DB
+- The data display table is simplified from the original version, because it was using a built in Vue component. This new table still shows everything in the data store, but is not sortable or paginated.
+- The help section below the example now has a horizontal row of tabs instead of vertical. This was done to keep the page responsive.
+- The example's colors and styling were updated to make it fit in with the new site, and to not be jarring when viewed in dark mode. The layout is also now responsive.
+- There are some new error checks for things like empty fields. These were throwing error logs to the console on the original. 
+- A few bugs were identified in the SpringRoll IDB implementation. Opening and deleting stores with incorrect version numbers can cause errors. This shouldn't affect most users under normal circumstances, but we've made a ticket to address this.
+
+
+### Removed Content
+- API documentation has been removed. It was automatically generated from code comments, but hasn't been actively maintained or organized. 
+- Captions Studio has been removed. It is now part of SpringRoll Studio.
+- The SpringRoll 1 section has been removed. It's no longer relevant as all developers should be using SpringRoll 2.
+- The GitHub wiki link to SpringRoll 1 documentation has also been removed.
+
+---------------------
+## Setup and Development
 ### Installation
 
 ```
-$ yarn
+$ npm install
 ```
 
 ### Local Development
 
 ```
-$ yarn start
+$ npm start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
 ```
-$ yarn build
+$ npm run build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-### Deployment
-
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
-```
-
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
 
 ### Examples
 
diff --git a/scripts/clone-demo-game.sh b/scripts/clone-demo-game.sh
@@ -3,11 +3,11 @@ set -euo pipefail
 IFS=$'\n\t'
 
 # Create the folder where we'll drop the demo game contents
-rm -rf static/springroll-io-demo-game
-mkdir static/springroll-io-demo-game
+rm -rf build/springroll-io-demo-game
+mkdir -p build/springroll-io-demo-game
 
 # Clone down the demo game
 rm -rf springroll-io-demo-game
 git clone --depth=1 https://github.com/SpringRoll/springroll-io-demo-game.git
-cp -R springroll-io-demo-game/docs/* static/springroll-io-demo-game
+cp -R springroll-io-demo-game/docs/* build/springroll-io-demo-game
 rm -rf springroll-io-demo-game
diff --git a/static/idbExample/index.html b/static/idbExample/index.html
@@ -225,7 +225,7 @@
 
     // Sets the text in the message line
     const setMessage = (message) => {
-      messageLine.innerHTML = message;
+      messageLine.textContent = message;
     }
 
     // Checks if the database name field is not empty

Original file line number	Diff line number	Diff line change
`@@ -225,7 +225,7 @@`
`225`	`225`
`226`	`226`	`// Sets the text in the message line`
`227`	`227`	`const setMessage = (message) => {`
`228`		`- messageLine.innerHTML = message;`
	`228`	`+ messageLine.textContent = message;`
`229`	`229`	`}`
`230`	`230`
`231`	`231`	`// Checks if the database name field is not empty`