Updated docs

Author: maxbilbow

docs/Requirements.md

@@ -1,47 +1,3 @@
-# Temperat agros cremet
+# About
 
-## Probarunt facta sua praeceps Sicanias puerum
-
-Lorem markdownum nympha? Undas virus eripitur parentes mater
-[iuvenumque](http://telephonexpulsa.com/iovisque) tempus tamen arcana, neve
-summo meritumque igitur. *Noctes creamur* Chariclo me operosa capite.
-
-> Viso ulla siqua inmunesque quoque, tollensque subruit unda tamen, perire:
-> tinnulaque sub cum! Deus remissos cape, *si resupinus* iussos
-> [vidit](http://www.coniunx.org/provida) Charybdis amico veteres territa:
-> gravis Cythereide abire formatum pugnet, pro.
-
-## Instimulat tenues
-
-Deriguit lacus [altissima](http://timent-viros.net/suosaperite), in undas
-fortuna! Pallade molli: [paulumque dei](http://www.tumulo.net/corpusque) est
-flabat odoribus Hippothousque, ille tua Haemonio patris poscentem deae versus.
-Viribus Heliadum hostem [vox](http://tendentemque.io/) tamen arma: versata
-**dicta sequentia qui**. Pello iuvenci secessit communes in **venit** disiecta
-iugo notam! Domestica solusque Dryantis ilia!
-
-Tenebant rettulit intonat citraque iacta. Nec inclusos, moratum lactis animique
-discedunt autumnos. Dea huic esset, ipso caeli eruerit moenia e Minervam corpore
-ferreus tinnitibus furor mansit: opes novat? Rursus dedecus sontes, proelia
-erat, vel alta Meleagron Scirone. Montis in Aeneaden, tectis quas, tot facinus
-passurae captus, ima et!
-
-## Habes parabat audit
-
-Palmis in genitore tonarent, clam me Ceycis ex tota iam terra inquit; longeque.
-Perpetuum iuvenalis blandisque Haemus solidum, liquet dolor potentior torum
-quiescet adesset vincat, natura lurida, tenentem impetus plenumque. Simplex quid
-exponit nam hospita matre! Caeli praecipue dedit is effugimus tamen et relaxant
-semina; et tenebat colubris: ensis sed per offensa quid.
-
-> Inminet in nova Deucalioneas piscem condor fit est tristes aevum alternaque
-> munere patriam **ut esse** petitis maturus ingenium fuit! Tactu par nisi amori
-> simul cum iam bene iacens dentes deus [mutavit
-> paelex](http://quoque-ratione.io/), veni. Confugit Iolao quod, ore falsa
-> vestros clipeo *iuvenalia* ceciderunt ignis, et hos ages fuisti dum diu illa,
-> est. Illa luna, cursus illum, quod Eueni fatale sentire.
-
-Corpora inquam tamen deducentia saepes perterrita, telae, pavefacta, mox partes
-verus, cara et pleni vel. Circumvolat debes diu dat mille quoque manum senectus
-increpor causa limus. Cum iuvenalibus iube potiora capiunt, natorum; falsosque
-Menephron.
+Developed by Max Bilbow as part of a Masters in Computer Science at Coventry University

docs/VSCode.md

@@ -0,0 +1,52 @@
+# ng2react Documentation
+
+ng2react is a tool that converts AngularJS components to React components using the OpenAI API. It consists of an IDE plugin, a core library, a CLI, and a feedback API.
+
+![System Context Diagram](./diagrams/structurizr-1-SystemContext.png)
+
+## Features
+
+- **Convert AngularJS Components**: The plugin allows users to easily convert AngularJS components to React components by sending the components to the ng2react core library, which uses TypeScript for parsing AngularJS components and the OpenAI API to generate the React version of the component.
+
+- **Feedback Submission**: The plugin enables users to submit feedback about the conversion results directly from the IDE. This feedback helps the ng2react team to identify areas for improvement and ensure the tool continues to meet user needs.
+
+- **User-friendly Interface**: The ng2react IDE plugin is designed with usability in mind, providing a seamless experience for developers working with both AngularJS and React codebases.
+
+## IDE Plugin
+
+The ng2react IDE plugin is an essential component of the ng2react software system. It integrates with the user's development environment and provides an interface for converting AngularJS components to React components using the core library. The plugin also enables users to submit feedback about the conversion results directly to the feedback API.
+
+Two types of IDE plugins are supported:
+
+- **NodeJS Based IDE Plugins**: These plugins are built for IDEs that support NodeJS plugins, such as VSCode and Atom. They can use @ng2react/core directly.
+- **Other IDE Plugins**: These plugins are built for IDEs that do not support NodeJS plugins, such as IntelliJ and Eclipse. They can be immpemented via the @ng2react/cli.
+
+### NodeJS Based IDE Plugin
+
+![NodeJS IDE Plugins](./diagramsstructurizr-1-VSCode_IDE.png)
+
+### Other IDE Plugins
+
+![Generic IDE Plugins](./diagrams/structurizr-1-Generic_IDE_CLI.png)
+
+## Ng2React
+
+### Core
+
+The ng2react core library is responsible for converting AngularJS components to React components. It leverages the TypeScript AST for parsing AngularJS components and uses the OpenAI API to generate the corresponding React components.
+
+### CLI
+
+The ng2react CLI is a command-line interface that enables developers to convert AngularJS components to React components without using an IDE plugin. It provides a convenient way for developers to integrate the ng2react functionality into their existing workflows and tooling.
+
+### Feedback API
+
+The feedback API allows users to submit feedback about the conversion results directly from the ng2react IDE plugin. It stores the feedback data in a database for later analysis and review by the ng2react team. This feedback is essential for identifying areas for improvement and ensuring the tool continues to meet user needs.
+
+![Feedback API](./diagrams/structurizr-1-Feedback_API.png)
+
+## Existing Plugins
+
+• [VSCode](https://marketplace.visualstudio.com/items?itemName=maxbilbow.ng2react-vscode)
+
+

docs/about.md

@@ -0,0 +1,42 @@
+# Getting Started
+
+1. Get an OpenAI API key from <https://openai.com/>
+2. Add the OpenAI API key to your IDE extension settings
+3. Open an AngularJS project and ensure that the source roots are configured correctly
+4. Run the `ng2react: Check Connection` command
+5. Install the `@ng2react/support` library in your AngularJS project: `npm install --save @ng2react/support`
+
+## Project Recommendations
+
+### Testing, testing testing
+
+The generated code is not guaranteed to be correct. It is generated by an AI model and may contain bugs. It is highly recommended that you write UI tests that will work for both AngularJS and React.
+
+If you currently use Protractor, you may want to consider switching to [Cypress](https://www.cypress.io). Cypress is a modern testing framework that is much easier to use and maintain than Protractor. It also supports both AngularJS and React.
+
+Good behavioural tests will help you catch bugs in the generated code and have confidence that parity has been achieved.
+
+### Use a UI component library
+
+## Configuration
+
+Important configuration options.
+
+### OpenAI Settings
+
+- `ng2react.openai.apiKey`: The OpenAI API key to use for generating React components from AngularJS components.
+- `ng2react.openai.model`: The OpenAI engine to use for generating React components from AngularJS components. Defaults to `gpt-4`.
+- `ng2react.openai.temperature`: The OpenAI temperature to use for generating React components from AngularJS components. Defaults to `0.2`.
+- `ng2react.openai.orginization`: An optional organization ID assiciated with your OpenAI account and can be used to prevent OpenAI from using your code to train their models.
+
+### Project Settings
+
+- `ng2react.source.angularRoot`: The source root of your AngularJS code. Defaults to `src`.
+- `ng2react.source.reactRoot`: The source root of your AngularJS code. Defaults to `src`.
+- `ng2react.source.testRoot`: The source root where React unit tests should be generated. Defaults to `src/test`.
+
+![VSCode Project .settings.json](./images/vscode_guide_project-settings.png)
+
+## Examples
+
+Have a look at some examples in [@ng2react/examples](https://github.com/ng2react/examples)