Added community node documentation

2024-08-30 20:32:17 +00:00 · 2023-07-19 22:04:17 +10:00 · 2023-07-19 22:04:17 +10:00 · 6ba48af0a9
commit 6ba48af0a9
parent 40fffec0b6
3 changed files with 85 additions and 7 deletions
--- a/docs/nodes/communityNodes.md
+++ b/docs/nodes/communityNodes.md
@ -0,0 +1,28 @@
+# Community Nodes
+
+These are nodes that have been developed by the community for the community. If you're not sure what a node is, you can learn more about nodes [here](overview.md).
+
+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 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. 
+
+## List of Nodes
+
+--------------------------------
+### Super Cool Node Template
+
+**Description:** This node allows you to do super cool things with InvokeAI.
+
+**Node Link:** https://github.com/invoke-ai/InvokeAI/fake_node.py
+
+**Example Node Graph:**  https://github.com/invoke-ai/InvokeAI/fake_node_graph.json
+
+**Output Examples** 
+
+![Invoke AI](https://invoke-ai.github.io/InvokeAI/assets/invoke_ai_banner.png)
+
+
+## Help
+If you run into any issues with a node, please post in the [InvokeAI Discord](https://discord.gg/ZmtBAhwWhy). 
--- a/docs/nodes/overview.md
+++ b/docs/nodes/overview.md
@ -0,0 +1,41 @@
+# Nodes
+## What are Nodes?
+An Node is simply a single operation that takes in some inputs and gives
+out some outputs. We can then chain multiple nodes together to create more
+complex functionality. All InvokeAI features are added through nodes.
+
+This means nodes can be used to easily extend the image generation capabilities of InvokeAI, and allow you build workflows to suit your needs. 
+
+You can read more about nodes and the node editor [here](../features/NODES.md). 
+
+
+## Downloading Nodes
+To download a new node, visit our list of [Community Nodes](communityNodes.md). These are codes that have been created by the community, for the community. 
+
+
+## Contributing Nodes
+
+To learn about creating a new node, please visit our [Node creation documenation](../contributing/INVOCATIONS.md). 
+
+Once you’ve created a node and confirmed that it behaves as expected locally, follow these steps: 
+- Make sure the node is contained in a new Python (.py) file 
+- Submit a pull request with a link to your node in GitHub against the `nodes` branch to add the node to the [Community Nodes](Community Nodes) list
+    - Make sure you are following the template below and have provided all relevant details about the node and what it does.
+- A maintainer will review the pull request and node. If the node is aligned with the direction of the project, you might be asked for permission to include it in the core project.
+
+### Community Node Template
+
+```markdown
+--------------------------------
+### Super Cool Node Template
+
+**Description:** This node allows you to do super cool things with InvokeAI.
+
+**Node Link:** https://github.com/invoke-ai/InvokeAI/fake_node.py
+
+**Example Node Graph:**  https://github.com/invoke-ai/InvokeAI/fake_node_graph.json
+
+**Output Examples** 
+
+![InvokeAI](https://invoke-ai.github.io/InvokeAI/assets/invoke_ai_banner.png)
+```
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -104,10 +104,10 @@ nav:
    - Installation: 
      - Overview: 'installation/index.md'
      - Installing with the Automated Installer: 'installation/010_INSTALL_AUTOMATED.md'
-      - Installing manually: 'installation/010_INSTALL_AUTOMATED.md'
+      - Installing manually: 'installation/020_INSTALL_MANUAL.md'
      - NVIDIA Cuda / AMD ROCm: 'installation/030_INSTALL_CUDA_AND_ROCM.md'
      - Installing with Docker: 'installation/040_INSTALL_DOCKER.md'
-      - Installing Models: 'installation/040_INSTALL_DOCKER.md'
+      - Installing Models: 'installation/050_INSTALLING_MODELS.md'
      - Installing PyPatchMatch: 'installation/060_INSTALL_PATCHMATCH.md'
      - Installing xFormers: 'installation/070_INSTALL_XFORMERS.md'
      - Developers Documentation: 'installation/Developers_documentation/BUILDING_BINARY_INSTALLERS.md'
@ -115,10 +115,13 @@ nav:
        - Binary Installer: 'installation/deprecated_documentation/INSTALL_BINARY.md'
        - Runninng InvokeAI on Google Colab: 'installation/deprecated_documentation/INSTALL_JUPYTER.md'
        - Manual Installation on Linux: 'installation/deprecated_documentation/INSTALL_LINUX.md'
-        - Manual Installation on macOS: 'installation/deprecated_documentation/INSTALL_macOS.md'
+        - Manual Installation on macOS: 'installation/deprecated_documentation/INSTALL_MAC.md'
        - Manual Installation on Windows: 'installation/deprecated_documentation/INSTALL_WINDOWS.md'
        - Installing Invoke with pip: 'installation/deprecated_documentation/INSTALL_PCP.md'
        - Source Installer: 'installation/deprecated_documentation/INSTALL_SOURCE.md'
+    - Community Nodes:
+      - Community Nodes: 'nodes/communityNodes.md'
+      - Overview: 'nodes/overview.md'
    - Features: 
      - Overview: 'features/index.md'
      - Concepts: 'features/CONCEPTS.md'
@ -139,18 +142,24 @@ nav:
      - Other: 'features/OTHER.md'
    - Contributing: 
      - How to Contribute: 'contributing/CONTRIBUTING.md'
-      - Development: 'contributing/contribution_guides/development.md'
+      - Development: 
+        - Overview: 'contributing/contribution_guides/development.md'
+        - InvokeAI Architecture: 'contributing/ARCHITECTURE.md'
+        - Frontend Documentation: 'contributing/contribution_guides/development_guides/contributingToFrontend.md'
+        - Local Development: 'contributing/LOCAL_DEVELOPMENT.md'
      - Documentation: 'contributing/contribution_guides/documentation.md'
      - Translation: 'contributing/contribution_guides/translation.md'
      - Tutorials: 'contributing/contribution_guides/tutorials.md'
-      - Local Development: contributing/LOCAL_DEVELOPMENT.md
    - Changelog: 'CHANGELOG.md'
    - Deprecated:
      - Command Line Interface: 'deprecated/CLI.md'
      - Embiggen: 'deprecated/EMBIGGEN.md'
-      - Inpainting: 'deprecated/INPAINTING.MD'
-      - Outpainting: 'deprecated/OUTPAINTING.MD'
+      - Inpainting: 'deprecated/INPAINTING.md'
+      - Outpainting: 'deprecated/OUTPAINTING.md'
    - Help:
      - Sampler Convergence: 'help/SAMPLER_CONVERGENCE.md'
+    - Other:
+      - Contributors: 'other/CONTRIBUTORS.md'
+      - CompViz-README: 'other/README-CompViz.md'