From a683379ddac6ce7a4c51992378b4c39a120cc914 Mon Sep 17 00:00:00 2001 From: Millun Atluri Date: Thu, 20 Jul 2023 09:28:21 +1000 Subject: [PATCH] Updated docs to be more accurate based on Lincoln's feedback --- docs/contributing/contribution_guides/development.md | 2 +- .../development_guides/contributingToFrontend.md | 10 +++++----- .../development_guides/contributingToNodes.md | 1 - docs/nodes/communityNodes.md | 2 +- 4 files changed, 7 insertions(+), 8 deletions(-) delete mode 100644 docs/contributing/contribution_guides/development_guides/contributingToNodes.md diff --git a/docs/contributing/contribution_guides/development.md b/docs/contributing/contribution_guides/development.md index 6c42efd051..584fb5a4ed 100644 --- a/docs/contributing/contribution_guides/development.md +++ b/docs/contributing/contribution_guides/development.md @@ -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. diff --git a/docs/contributing/contribution_guides/development_guides/contributingToFrontend.md b/docs/contributing/contribution_guides/development_guides/contributingToFrontend.md index ee0a4ef1cb..08f7c69ce7 100644 --- a/docs/contributing/contribution_guides/development_guides/contributingToFrontend.md +++ b/docs/contributing/contribution_guides/development_guides/contributingToFrontend.md @@ -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 diff --git a/docs/contributing/contribution_guides/development_guides/contributingToNodes.md b/docs/contributing/contribution_guides/development_guides/contributingToNodes.md deleted file mode 100644 index f5f0962bd0..0000000000 --- a/docs/contributing/contribution_guides/development_guides/contributingToNodes.md +++ /dev/null @@ -1 +0,0 @@ -# Contributing to Nodes \ No newline at end of file diff --git a/docs/nodes/communityNodes.md b/docs/nodes/communityNodes.md index 2c6941d3c8..a17ac05f3b 100644 --- a/docs/nodes/communityNodes.md +++ b/docs/nodes/communityNodes.md @@ -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.