mirror of
https://github.com/invoke-ai/InvokeAI.git
synced 2026-10-12 02:16:43 +00:00
fix(docs): anticipate more redirects and update more links (#9076)
Co-authored-by: joshistoast <[email protected]>
This commit is contained in:
Josh Corbett
co-authored by
joshistoast
joshistoast
parent
6d5a788f76
commit
f621bc8fd2
@@ -1,7 +1,7 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Project-Documentation
|
||||
url: https://invoke-ai.github.io/InvokeAI/
|
||||
url: https://invoke.ai/
|
||||
about: Should be your first place to go when looking for manuals/FAQs regarding our InvokeAI Toolkit
|
||||
- name: Discord
|
||||
url: https://discord.gg/ZmtBAhwWhy
|
||||
|
||||
@@ -106,14 +106,14 @@ Invoke is a combined effort of [passionate and talented people from across the w
|
||||
|
||||
Original portions of the software are Copyright © 2024 by respective contributors.
|
||||
|
||||
[features docs]: https://invoke-ai.github.io/InvokeAI/features/database/
|
||||
[faq]: https://invoke-ai.github.io/InvokeAI/faq/
|
||||
[contributors]: https://invoke-ai.github.io/InvokeAI/contributing/contributors/
|
||||
[features docs]: https://invoke.ai/
|
||||
[faq]: https://invoke.ai/troubleshooting/faq/
|
||||
[contributors]: https://invoke.ai/contributing/contributors/
|
||||
[github issues]: https://github.com/invoke-ai/InvokeAI/issues
|
||||
[docs home]: https://invoke.ai
|
||||
[installation docs]: https://invoke.ai/start-here/installation/
|
||||
[#dev-chat]: https://discord.com/channels/1020123559063990373/1049495067846524939
|
||||
[contributing docs]: https://invoke-ai.github.io/InvokeAI/contributing/
|
||||
[contributing docs]: https://invoke.ai/contributing/
|
||||
[CI checks on main badge]: https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/main?label=CI%20status%20on%20main&cache=900&icon=github
|
||||
[CI checks on main link]: https://github.com/invoke-ai/InvokeAI/actions?query=branch%3Amain
|
||||
[discord badge]: https://flat.badgen.net/discord/members/ZmtBAhwWhy?icon=discord
|
||||
|
||||
+1
-1
@@ -109,7 +109,7 @@ CONTAINER_UID=1000
|
||||
GPU_DRIVER=cuda
|
||||
```
|
||||
|
||||
Any environment variables supported by InvokeAI can be set here. See the [Configuration docs](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/) for further detail.
|
||||
Any environment variables supported by InvokeAI can be set here. See the [Configuration docs](https://invoke.ai/configuration/invokeai-yaml/) for further detail.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -137,9 +137,41 @@ export default defineConfig({
|
||||
}),
|
||||
],
|
||||
redirects: {
|
||||
'/CODE_OF_CONDUCT': '/contributing/code-of-conduct',
|
||||
'/RELEASE': '/development/process/release-process',
|
||||
'/installation': '/start-here/installation',
|
||||
'/installation/docker': '/configuration/docker',
|
||||
'/installation/manual': '/start-here/manual',
|
||||
'/installation/models': '/concepts/models',
|
||||
'/installation/patchmatch': '/configuration/patchmatch',
|
||||
'/installation/quick_start': '/start-here/installation',
|
||||
'/installation/requirements': '/start-here/system-requirements',
|
||||
'/configuration': '/configuration/invokeai-yaml',
|
||||
'/features/low-vram/': '/configuration/low-vram-mode/',
|
||||
'/faq': '/troubleshooting/faq',
|
||||
'/help/SAMPLER_CONVERGENCE': '/concepts/parameters',
|
||||
'/help/diffusion': '/concepts/diffusion',
|
||||
'/help/gettingStartedWithAI': '/concepts/image-generation',
|
||||
'/nodes/NODES': '/workflows/editor-interface',
|
||||
'/nodes/NODES_MIGRATION_V3_V4': '/development/guides/api-development',
|
||||
'/nodes/comfyToInvoke': '/workflows/comfyui-migration',
|
||||
'/nodes/communityNodes': '/workflows/community-nodes',
|
||||
'/nodes/contributingNodes': '/development/guides/creating-nodes',
|
||||
'/nodes/invocation-api': '/development/guides/api-development',
|
||||
'/contributing/ARCHITECTURE': '/development/architecture/overview',
|
||||
'/contributing/DOWNLOAD_QUEUE': '/development/architecture/model-manager',
|
||||
'/contributing/HOTKEYS': '/features/hotkeys',
|
||||
'/contributing/INVOCATIONS': '/development/architecture/invocations',
|
||||
'/contributing/LOCAL_DEVELOPMENT': '/development/setup/dev-environment',
|
||||
'/contributing/MODEL_MANAGER': '/development/architecture/model-manager',
|
||||
'/contributing/NEW_MODEL_INTEGRATION': '/development/guides/models',
|
||||
'/contributing/PR-MERGE-POLICY': '/development/process/pr-merge-policy',
|
||||
'/contributing/TESTS': '/development/guides/tests',
|
||||
'/contributing/contribution_guides/development': '/development',
|
||||
'/contributing/contribution_guides/newContributorChecklist': '/contributing/new-contributor-guide',
|
||||
'/contributing/dev-environment': '/development/setup/dev-environment',
|
||||
'/contributing/frontend': '/development/front-end',
|
||||
'/contributing/frontend/state-management': '/development/front-end/state-management',
|
||||
'/contributing/frontend/workflows': '/development/front-end/workflows',
|
||||
}
|
||||
});
|
||||
|
||||
@@ -55,7 +55,7 @@ On the [Docker Desktop app](https://docs.docker.com/get-docker/), go to `Prefere
|
||||
|
||||
Set up your environment variables. In the `docker` directory, make a copy of `.env.sample` and name it `.env`. Make changes as necessary.
|
||||
|
||||
Any environment variables supported by InvokeAI can be set here - please see [Configurations](../configuration.md) for further detail.
|
||||
Any environment variables supported by InvokeAI can be set here - please see the [configuration docs](/configuration/invokeai-yaml/) for further detail.
|
||||
|
||||
At the very least, you might want to set the `INVOKEAI_ROOT` environment variable
|
||||
to point to the location where you wish to store your InvokeAI models, configuration, and outputs.
|
||||
|
||||
@@ -49,7 +49,7 @@ It has two sections - one for internal use and one for user settings:
|
||||
# Internal metadata - do not edit:
|
||||
schema_version: 4.0.2
|
||||
|
||||
# Put user settings here - see https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/:
|
||||
# Put user settings here - see https://invoke.ai/configuration/invokeai-yaml/:
|
||||
host: 0.0.0.0 # serve the app on your local network
|
||||
models_dir: D:\invokeai\models # store models on an external drive
|
||||
precision: float16 # always use fp16 precision
|
||||
|
||||
@@ -10,13 +10,13 @@ We welcome contributions, whether features, bug fixes, code cleanup, testing, co
|
||||
|
||||
## Development
|
||||
|
||||
If you’d like to help with development, please see our [development guide](contribution_guides/development.md).
|
||||
If you’d like to help with development, please see our [development guide](/development/).
|
||||
|
||||
**New Contributors:** If you’re unfamiliar with contributing to open source projects, take a look at our [new contributor guide](contribution_guides/newContributorChecklist.md).
|
||||
**New Contributors:** If you’re unfamiliar with contributing to open source projects, take a look at our [new contributor guide](/contributing/new-contributor-guide/).
|
||||
|
||||
## Nodes
|
||||
|
||||
If you’d like to add a Node, please see our [nodes contribution guide](../nodes/contributingNodes.md).
|
||||
If you’d like to add a Node, please see our [nodes contribution guide](/development/guides/creating-nodes/).
|
||||
|
||||
## Support and Triaging
|
||||
|
||||
@@ -42,7 +42,7 @@ This project is a combined effort of dedicated people from across the world. [C
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
The InvokeAI community is a welcoming place, and we want your help in maintaining that. Please review our [Code of Conduct](../CODE_OF_CONDUCT.md) to learn more - it's essential to maintaining a respectful and inclusive environment.
|
||||
The InvokeAI community is a welcoming place, and we want your help in maintaining that. Please review our [Code of Conduct](/contributing/code-of-conduct/) to learn more - it's essential to maintaining a respectful and inclusive environment.
|
||||
|
||||
By making a contribution to this project, you certify that:
|
||||
|
||||
|
||||
@@ -12,9 +12,9 @@ If you're a new contributor to InvokeAI or Open Source Projects, this is the gui
|
||||
<Steps>
|
||||
1. Set up your local development environment & fork of InvokAI by following [the steps outlined here](../../development/setup/dev-environment/#initial-setup)
|
||||
|
||||
2. Set up your local tooling with [this guide](../LOCAL_DEVELOPMENT.md). Feel free to skip this step if you already have tooling you're comfortable with.
|
||||
2. Set up your local tooling with [this guide](/development/). Feel free to skip this step if you already have tooling you're comfortable with.
|
||||
|
||||
3. Familiarize yourself with [Git](https://www.atlassian.com/git) & our project structure by reading through the [development documentation](development.md)
|
||||
3. Familiarize yourself with [Git](https://www.atlassian.com/git) & our project structure by reading through the [development documentation](/development/)
|
||||
|
||||
4. Join the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord
|
||||
|
||||
@@ -29,7 +29,7 @@ If you're a new contributor to InvokeAI or Open Source Projects, this is the gui
|
||||
|
||||
Never made an open source contribution before? Wondering how contributions work in our project? Here's a quick rundown!
|
||||
|
||||
Before starting these steps, ensure you have your local environment [configured for development](../LOCAL_DEVELOPMENT.md).
|
||||
Before starting these steps, ensure you have your local environment [configured for development](/development/setup/dev-environment/).
|
||||
|
||||
<Steps>
|
||||
1. Find a [good first issue](https://github.com/invoke-ai/InvokeAI/contribute) that you are interested in addressing or a feature that you would like to add. Then, reach out to our team in the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord to ensure you are setup for success.
|
||||
|
||||
@@ -316,8 +316,8 @@ new Invocation ready to be used.
|
||||
|
||||
Once you've created a Node, the next step is to share it with the community! The
|
||||
best way to do this is to submit a Pull Request to add the Node to the
|
||||
[Community Nodes](../nodes/communityNodes.md) list. If you're not sure how to do that,
|
||||
take a look a at our [contributing nodes overview](../nodes/contributingNodes.md).
|
||||
[Community Nodes](/workflows/community-nodes/) list. If you're not sure how to do that,
|
||||
take a look a at our [contributing nodes overview](/development/guides/creating-nodes/).
|
||||
|
||||
## Advanced
|
||||
|
||||
|
||||
@@ -93,7 +93,7 @@ The session graph does not support looping. This is left as an application probl
|
||||
|
||||
### Invocations
|
||||
|
||||
Invocations represent individual units of execution, with inputs and outputs. All invocations are located in `/invokeai/app/invocations`, and are all automatically discovered and made available in the applications. These are the primary way to expose new functionality in Invoke.AI, and the [implementation guide](INVOCATIONS.md) explains how to add new invocations.
|
||||
Invocations represent individual units of execution, with inputs and outputs. All invocations are located in `/invokeai/app/invocations`, and are all automatically discovered and made available in the applications. These are the primary way to expose new functionality in Invoke.AI, and the [implementation guide](/development/architecture/invocations/) explains how to add new invocations.
|
||||
|
||||
### Services
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ Invoke's UI is made possible by many contributors and open-source libraries. Tha
|
||||
|
||||
## Dev environment
|
||||
|
||||
Follow the [dev environment](../dev-environment.md) guide to get set up. Run the UI using `pnpm dev`.
|
||||
Follow the [dev environment](/development/setup/dev-environment/) guide to get set up. Run the UI using `pnpm dev`.
|
||||
|
||||
## Package scripts
|
||||
|
||||
|
||||
@@ -81,7 +81,7 @@ But, if you want to be extra-super careful, here's how to test it:
|
||||
|
||||
- Download the `dist.zip` build artifact from the `build-wheel` job
|
||||
- Unzip it and find the wheel file
|
||||
- Create a fresh Invoke install by following the [manual install guide](https://invoke-ai.github.io/InvokeAI/installation/manual/) - but instead of installing from PyPI, install from the wheel
|
||||
- Create a fresh Invoke install by following the [manual install guide](/start-here/manual/) - but instead of installing from PyPI, install from the wheel
|
||||
- Test the app
|
||||
|
||||
##### Something isn't right
|
||||
@@ -116,7 +116,7 @@ This job is not required for the production PyPI publish, but included just in c
|
||||
|
||||
- Approve this publish job without approving the prod publish
|
||||
- Let it finish
|
||||
- Create a fresh Invoke install by following the [manual install guide](https://invoke-ai.github.io/InvokeAI/installation/manual/), making sure to use the Test PyPI index URL: `https://test.pypi.org/simple/`
|
||||
- Create a fresh Invoke install by following the [manual install guide](/start-here/manual/), making sure to use the Test PyPI index URL: `https://test.pypi.org/simple/`
|
||||
- Test the app
|
||||
|
||||
#### `publish-pypi` Job
|
||||
|
||||
@@ -44,7 +44,7 @@ import SystemRequirementsLink from '@components/SystemRequirmentsLink.astro'
|
||||
git lfs pull
|
||||
```
|
||||
4. Create a directory for user data (images, models, db, etc). This is typically at `~/invokeai`, but if you already have a non-dev install, you may want to create a separate directory for the dev install.
|
||||
5. Follow the [manual install](../installation/manual) guide, with some modifications to the install command:
|
||||
5. Follow the [manual install](/start-here/manual/) guide, with some modifications to the install command:
|
||||
|
||||
- Use `.` instead of `invokeai` to install from the current directory. You don't need to specify the version.
|
||||
- Add `-e` after the `install` operation to make this an [editable install](https://pip.pypa.io/en/latest/cli/pip_install/#cmdoption-e). That means your changes to the python code will be reflected when you restart the Invoke server.
|
||||
|
||||
@@ -107,7 +107,7 @@ Additionally, each image has a context menu (right-click or Ctrl+click) with pow
|
||||
|
||||
## Summary
|
||||
|
||||
This walkthrough covers the Gallery interface and Boards. For instructions on actually generating images, please refer to the documentation on [Prompts](PROMPTS.md), the [Image to Image](IMG2IMG.md) tab, and the [Unified Canvas](UNIFIED_CANVAS.md).
|
||||
This walkthrough covers the Gallery interface and Boards. For guidance on prompting and generation workflows, please refer to the [Prompting Guide](/concepts/prompting-guide/) and [AI Image Generation](/concepts/image-generation/).
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
|
||||
@@ -78,7 +78,7 @@ Whether you are looking to install the app, get support, train your own models,
|
||||
|
||||
<CardGrid>
|
||||
<Card title="Get Installed" icon="download">
|
||||
Ready to dive in? The [Invoke Launcher](installation/quick_start.md) is the fastest way to get up and running on Windows, macOS, and Linux. For advanced setups, try [Docker](installation/docker.md) or a [manual Python installation](installation/manual.md).
|
||||
Ready to dive in? The [Invoke Launcher](/start-here/installation/) is the fastest way to get up and running on Windows, macOS, and Linux. For advanced setups, try [Docker](/configuration/docker/) or a [manual Python installation](/start-here/manual/).
|
||||
|
||||
<LinkButton href="download" icon="right-arrow">
|
||||
Get Invoke
|
||||
@@ -94,7 +94,7 @@ Whether you are looking to install the app, get support, train your own models,
|
||||
</Card>
|
||||
|
||||
<Card title="Get Support" icon="discord">
|
||||
Stuck? Check out our comprehensive [FAQ](./faq.md) for quick answers. If you still need a hand, our community is incredibly active and helpful.
|
||||
Stuck? Check out our comprehensive [FAQ](/troubleshooting/faq/) for quick answers. If you still need a hand, our community is incredibly active and helpful.
|
||||
|
||||
<LinkButton href="https://discord.gg/ZmtBAhwWhy" variant="secondary" icon="discord">Join our Discord</LinkButton>
|
||||
</Card>
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
title: 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).
|
||||
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](/concepts/nodes-workflows/).
|
||||
|
||||
If you'd like to submit a node for the community, please refer to the [node creation overview](contributingNodes.md).
|
||||
If you'd like to submit a node for the community, please refer to the [node creation overview](/development/guides/creating-nodes/).
|
||||
|
||||
To use a node, add the node to the `nodes` folder found in your InvokeAI install location.
|
||||
|
||||
|
||||
@@ -268,7 +268,7 @@ class InvokeAIAppConfig(BaseSettings):
|
||||
file.write("# Internal metadata - do not edit:\n")
|
||||
file.write(yaml.dump(meta_dict, sort_keys=False))
|
||||
file.write("\n")
|
||||
file.write("# Put user settings here - see https://invoke-ai.github.io/InvokeAI/configuration/:\n")
|
||||
file.write("# Put user settings here - see https://invoke.ai/configuration/invokeai-yaml/:\n")
|
||||
if len(config_dict) > 0:
|
||||
file.write(yaml.dump(config_dict, sort_keys=False))
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# Invoke UI
|
||||
|
||||
<https://invoke-ai.github.io/InvokeAI/contributing/frontend/>
|
||||
<https://invoke.ai/development/front-end/>
|
||||
|
||||
@@ -6,7 +6,7 @@ import { useCallback, useMemo } from 'react';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import type { Param0 } from 'tsafe';
|
||||
|
||||
const CLIPBOARD_FAQ_URL = 'https://invoke-ai.github.io/InvokeAI/faq/#unable-to-copy-on-firefox';
|
||||
const CLIPBOARD_FAQ_URL = 'https://invoke.ai/troubleshooting/faq/#unable-to-copy-on-firefox';
|
||||
|
||||
export const useClipboard = () => {
|
||||
const { t } = useTranslation();
|
||||
|
||||
+1
-1
@@ -177,7 +177,7 @@ const LowVRAMAlert = () => {
|
||||
<Trans
|
||||
i18nKey="newUserExperience.lowVRAMMode"
|
||||
components={{
|
||||
LinkComponent: <ExternalLink href="https://invoke-ai.github.io/InvokeAI/features/low-vram/" />,
|
||||
LinkComponent: <ExternalLink href="https://invoke.ai/configuration/low-vram-mode/" />,
|
||||
}}
|
||||
/>
|
||||
</AlertDescription>
|
||||
|
||||
@@ -17,7 +17,7 @@ export default function ErrorToastDescription({ errorType, errorMessage }: Descr
|
||||
<Trans
|
||||
i18nKey="toast.outOfMemoryErrorDescLocal"
|
||||
components={{
|
||||
LinkComponent: <ExternalLink href="https://invoke-ai.github.io/InvokeAI/features/low-vram/" />,
|
||||
LinkComponent: <ExternalLink href="https://invoke.ai/configuration/low-vram-mode/" />,
|
||||
}}
|
||||
/>
|
||||
);
|
||||
|
||||
@@ -74,7 +74,7 @@ export const buildOnModelInstallError = (getState: AppGetState, dispatch: AppDis
|
||||
{t('modelManager.urlUnauthorizedErrorMessage')}
|
||||
<ExternalLink
|
||||
label={t('modelManager.urlUnauthorizedErrorMessage2')}
|
||||
href="https://invoke-ai.github.io/InvokeAI/configuration/#model-marketplace-api-keys"
|
||||
href="https://invoke.ai/configuration/invokeai-yaml/#model-marketplace-api-keys"
|
||||
/>
|
||||
</Text>
|
||||
),
|
||||
|
||||
+2
-2
@@ -169,8 +169,8 @@ explicit = true
|
||||
"invoke-usermod" = "invokeai.app.util.user_management:usermod"
|
||||
|
||||
[project.urls]
|
||||
"Homepage" = "https://invoke-ai.github.io/InvokeAI/"
|
||||
"Documentation" = "https://invoke-ai.github.io/InvokeAI/"
|
||||
"Homepage" = "https://invoke.ai/"
|
||||
"Documentation" = "https://invoke.ai/"
|
||||
"Source" = "https://github.com/invoke-ai/InvokeAI/"
|
||||
"Bug Reports" = "https://github.com/invoke-ai/InvokeAI/issues"
|
||||
"Discord" = "https://discord.gg/ZmtBAhwWhy"
|
||||
|
||||
Reference in New Issue
Block a user