Skip to content

Commit 9e5659c

Browse files
committed
Fixed docs
1 parent 8a100f9 commit 9e5659c

File tree

6 files changed

+78
-76
lines changed

6 files changed

+78
-76
lines changed

docs/MkDocs.md

-17
This file was deleted.

docs/about.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
11
# About
22

3-
Developed by Max Bilbow as part of a Masters in Computer Science at Coventry University
3+
Developed by Max Bilbow as part of a Masters in Computer Science at Coventry University
4+
5+
6+
<!-- # Welcome to MkDocs
7+
8+
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
9+
10+
## Commands
11+
12+
* `mkdocs new [dir-name]` - Create a new project.
13+
* `mkdocs serve` - Start the live-reloading docs server.
14+
* `mkdocs build` - Build the documentation site.
15+
* `mkdocs -h` - Print help message and exit.
16+
17+
## Project layout
18+
19+
mkdocs.yml # The configuration file.
20+
docs/
21+
index.md # The documentation homepage.
22+
... # Other markdown pages, images and other files. -->

docs/contribute.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contribute
2+
3+
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 with native bridge interfaces for non-JavaScript IDEs, and a support library for hybrid AngularJS/React projects.
4+
5+
## IDE Plugin
6+
7+
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.
8+
9+
Two types of IDE plugins are supported:
10+
11+
- **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.
12+
- **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.
13+
14+
### NodeJS Based IDE Plugin
15+
16+
![NodeJS IDE Plugins](./diagrams/structurizr-1-VSCode_IDE.png)
17+
18+
### Other IDE Plugins
19+
20+
![Generic IDE Plugins](./diagrams/structurizr-1-Generic_IDE.png)
21+
22+
### Existing Plugins
23+
24+
- [VSCode](https://marketplace.visualstudio.com/items?itemName=maxbilbow.ng2react-vscode)
25+
- [IntelliJ](https://github.com/ng2react/intellij) (PoC - Contributions welcome)
26+
27+
## How to Contribute
28+
29+
If your target IDE is not JavaScript based (e.g. VSCode), you will need to use or create a bridge API.
30+
31+
### Creating a Native Bridge
32+
33+
To do this, start by finding the appropriate JSON Schema generation library for your target language. For example: the [Java library](https://github.com/ng2react/cli/tree/main/libraries/java) uses the [jsonschema2pojo-maven-plugin](https://mvnrepository.com/artifact/org.jsonschema2pojo/jsonschema2pojo-maven-plugin) to generate the Pojos for interfacing with the [CLI](https://github.com/ng2react/cli)
34+
35+
Submit a PR into the [@ng2react/cli](https://github.com/ng2react/cli) repository with you native bridge implementation.
36+
37+
**Current Native Bridges:**
38+
39+
- Java (for IntelliJ)
40+
41+
### Build your native plugin
42+
43+
Now that you have a native bridge that can interface seamlessly with the CLI, you can build your native plugin. You can maintain it yourself or ask to have it added to the [@ng2react](https://github.com/ng2react) project.
44+
45+
You may look at the VSCode extension for examples but, so log ans you can scan for and convert components, you can build your plugin however you like.
46+
47+
### Scan JavaScript for AngularJS Components
48+
49+
![Scan for components](./diagrams/structurizr-1-ScanProject.png)
50+
51+
### Convert Component
52+
53+
![Convert component](./diagrams/structurizr-1-Dynamic-001.png)

docs/documentation.md

-52
This file was deleted.

docs/user-guide.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# User Guide
22

3-
Tree View
4-
Context Actions
5-
Command Palette
6-
• Test Generation
3+
* Tree View
4+
* Context Actions
5+
* Command Palette
6+
* Test Generation
77

88
## Tree View: Finding & Converting Components
99

mkdocs.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ nav:
55
- Getting Started: getting-started.md
66
- User Guide: user-guide.md
77
- "@ng2react/support": ng2react-support.md
8-
- Docs: documentation.md
8+
- Contribute: contribute.md
99
- About: about.md
10-
# - MkDocs: MkDocs.md
1110
theme:
1211
name: readthedocs
1312
highlightjs: true

0 commit comments

Comments
 (0)