Mirrored_Repos/InvokeAI
1
0
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs to be more accurate based on Lincoln's feedback

Browse Source
This commit is contained in:
Millun Atluri 2023-07-20 09:28:21 +10:00
parent 899aa1d251
commit a683379dda
4 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/contribution_guides/development.md
View File

@ -66,7 +66,7 @@ git commit -m "Insert a short message of the changes made here"
git push origin branch-name-here
```
1. Submit a pull request to the **development** branch of the InvokeAI repository.
1. Submit a pull request to the **main** branch of the InvokeAI repository.
2. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #1234".
3. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
4. Wait for the pull request to be reviewed by other collaborators.

10
docs/contributing/contribution_guides/development_guides/contributingToFrontend.md
View File

@ -10,7 +10,7 @@
The UI is a fairly straightforward Typescript React app, with the Unified Canvas being more complex.
Code is located in `invokeai/frontend/web/` for review.
Code is located in `invokeai/frontend/web/src` for review.
## Stack
@ -45,10 +45,10 @@ Install [node](https://nodejs.org/en/download/) and [yarn classic](https://cl
From `invokeai/frontend/web/` run `yarn install` to get everything set up.
Start everything in dev mode:
1. Start the dev server: `yarn dev`
2. Start the InvokeAI Nodes backend: `python scripts/invokeai-web.py # run from the repo root`
3. Point your browser to the dev server address e.g. [http://localhost:5173/](http://localhost:5173/)
1. Ensure your virtual environment is running
2. Start the dev server: `yarn dev`
3. Start the InvokeAI Nodes backend: `python scripts/invokeai-web.py # run from the repo root`
4. Point your browser to the dev server address e.g. [http://localhost:5173/](http://localhost:5173/)
### VSCode Remote Dev

1
docs/contributing/contribution_guides/development_guides/contributingToNodes.md
View File

@ -1 +0,0 @@
# Contributing to Nodes

2
docs/nodes/communityNodes.md
View File

@ -4,7 +4,7 @@ These are nodes that have been developed by the community for the community. If
If you'd like to submit a node for the community, please refer to the [node creation overview](overview.md).
To download a node, simply download the `.py` node file from the link and add it to the `/app/invocations/` folder in your Invoke AI install location. Along with the node, an example node graph should be provided to help you get started with the node.
To download a node, simply download the `.py` node file from the link and add it to the `invoke/app/invocations/` folder in your Invoke AI install location. Along with the node, an example node graph should be provided to help you get started with the node.
To use a community node graph, download the the `.json` node graph file and load it into Invoke AI via the **Load Nodes** button on the Node Editor.