Adding notes

Author: Pietro Passarelli

.gitignore

@@ -110,9 +110,9 @@ node_modules
 
 
 .idea
-Notes
+# Notes
 
-notes.md
+# notes.md
 
 .env
 

docs/notes/2019-04-16-name-change-dpe-to-autoEdit-3.md

@@ -0,0 +1,44 @@
+# name change - dpe to autoEdit 3  
+Decide to change the name of the app to `autoEdit 3`, to use the `autoEdit.io` domain, and encourage `autoEdit2` users to move onto this version of the app.
+
+However would rather avoid introducing breaking changes for existing  `digital-paper-edit-electron` users. 
+so in `package.json` the `name` of the app will remain to `digital-paper-edit-electron`. but will change the `productName`.
+
+>`productName` String - As `name`, but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the name property.
+
+[see electron builder docs for more details](https://www.electron.build/configuration/configuration#configuration)
+
+in `package.json` added
+```json
+  "productName":"autoEdit 3",
+```
+
+and in `src/electron-main.js`, set the  `userData` manually.
+
+
+`appData` on mac is `~/Library/Application Support`
+while  `userData` is the folder within `appData`, which would default to `name` or `productName` in `package.json`
+
+```js
+// set userData to use `digital-paper-edit-electron` to be backward compatible before name change from `digital-paper-edit-electron` to `autoEdit 3`;
+
+// const userDataPath = app.getPath ('userData');
+const appData = app.getPath ('appData');
+app.setPath ('userData', path.join(appData,"digital-paper-edit-electron"));
+```
+
+for more background info see 
+
+- [electron docs - `app.setPath(name, path)`](https://www.electronjs.org/docs/api/app#appsetpathname-path)
+- [stackoverflow- Electron: How to set a custom directory for user data (--user-data-dir)](https://stackoverflow.com/questions/48587035/electron-how-to-set-a-custom-directory-for-user-data-user-data-dir)
+- [electron docs -   `app.getPath(name)`](https://github.com/electron/electron/blob/master/docs/api/app.md#appgetpathname)
+
+
+## side notes
+one concern is if someone downloads an electron build form `bbc/digital-paper-edit-electron` and wants to run it along side `autoEdit 3`.
+They'd be using the same `userData` folder. 
+
+However since `bbc/digital-paper-edit-electron` electron version is not being activly developed, in favour of a web version, this seems to be an edge case for now.
+
+
+Another note, is that keeping the name of the github repos to `digital-paper-edit-*` to avoid renaming all of the forks, might cause confusion amongst developers who might want to contribute to the project, so might need to add a note or explanation somewhere, or even link to this now. While at the user facing level, adjsuting the name in the user manual, and with the new landing page it should be fairly straightforward. 

docs/notes/2019-12-23-node-windows-path-parse-join-issue.md

@@ -0,0 +1,66 @@
+# node windows path parse join issue
+
+Some notes about troubleshooting of node and path for windows electron from issue
+[bbc/digital-paper-edit-electron/issues/10](https://github.com/bbc/digital-paper-edit-electron/issues/10)
+
+main issue is that when converting to audio, it tries write the new audio file at path destination with double `C:\C:\`.
+
+
+Most likely due to issues when parsing and re-building the destination path on widows.
+
+
+In `convertToAudio` the function `wavFileExtension`,
+
+```js
+/**
+ * Adding an helper function to force the file extension to be `.wav`
+ * this also allows the file extension in output file name/path to be optional
+ * @param {string} path - path to an audio file
+ */
+function wavFileExtension(filePath) {
+  let audioFileOutputPath = filePath;
+  // https://nodejs.org/api/path.html#path_path_parse_path
+  const pathParsed = path.parse(audioFileOutputPath);
+  if (pathParsed.ext !== '.wav') {
+    audioFileOutputPath = path.join(pathParsed.root, pathParsed.dir, `${ pathParsed.name }.wav`);
+  }
+
+  return audioFileOutputPath;
+}
+```
+
+`path.parse`
+
+>`> path.parse('/Users/userName/someFolder/file.mov')`
+
+```js
+{
+  root: '/',
+  dir: '/Users/userName/someFolder',
+  base: 'file.mov',
+  ext: '.mov',
+  name: 'file'
+}
+```
+
+`path.join`
+
+```js
+path.join(pathParsed.root, pathParsed.dir, `${ pathParsed.name }.wav`);
+```
+Adding root and dir on windows, it adds `C:\` twice.
+
+
+`path.format` could be a good way to tackle this, for now trying just by removing `.root` in `path.join`.
+
+```js
+function wavFileExtension(filePath) {
+  let audioFileOutputPath = filePath;
+  const pathParsed = path.parse(audioFileOutputPath);
+  if (pathParsed.ext !== '.wav') {
+    audioFileOutputPath = path.join(pathParsed.dir, `${ pathParsed.name }.wav`);
+  }
+
+  return audioFileOutputPath;
+}
+```

docs/notes/2020-02-24-electron-ipc-and-stt.md

@@ -0,0 +1,10 @@
+# Electron and STT
+
+offloading STT to a hidden window render process.
+
+
+more here
+
+- https://medium.com/swlh/how-to-run-background-worker-processes-in-an-electron-app-e0dc310a93cc
+- https://www.electronjs.org/docs/api/ipc-main#ipcmain
+- https://www.electronjs.org/docs/api/ipc-main