Skip to content

Commit f621bc8

Browse files
joshistoastjoshistoast
andauthored
fix(docs): anticipate more redirects and update more links (#9076)
Co-authored-by: joshistoast <me@joshcorbett.com>
1 parent 6d5a788 commit f621bc8

23 files changed

Lines changed: 67 additions & 35 deletions

File tree

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Project-Documentation
4-
url: https://invoke-ai.github.io/InvokeAI/
4+
url: https://invoke.ai/
55
about: Should be your first place to go when looking for manuals/FAQs regarding our InvokeAI Toolkit
66
- name: Discord
77
url: https://discord.gg/ZmtBAhwWhy

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,14 @@ Invoke is a combined effort of [passionate and talented people from across the w
106106

107107
Original portions of the software are Copyright © 2024 by respective contributors.
108108

109-
[features docs]: https://invoke-ai.github.io/InvokeAI/features/database/
110-
[faq]: https://invoke-ai.github.io/InvokeAI/faq/
111-
[contributors]: https://invoke-ai.github.io/InvokeAI/contributing/contributors/
109+
[features docs]: https://invoke.ai/
110+
[faq]: https://invoke.ai/troubleshooting/faq/
111+
[contributors]: https://invoke.ai/contributing/contributors/
112112
[github issues]: https://github.com/invoke-ai/InvokeAI/issues
113113
[docs home]: https://invoke.ai
114114
[installation docs]: https://invoke.ai/start-here/installation/
115115
[#dev-chat]: https://discord.com/channels/1020123559063990373/1049495067846524939
116-
[contributing docs]: https://invoke-ai.github.io/InvokeAI/contributing/
116+
[contributing docs]: https://invoke.ai/contributing/
117117
[CI checks on main badge]: https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/main?label=CI%20status%20on%20main&cache=900&icon=github
118118
[CI checks on main link]: https://github.com/invoke-ai/InvokeAI/actions?query=branch%3Amain
119119
[discord badge]: https://flat.badgen.net/discord/members/ZmtBAhwWhy?icon=discord

docker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ CONTAINER_UID=1000
109109
GPU_DRIVER=cuda
110110
```
111111

112-
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.
112+
Any environment variables supported by InvokeAI can be set here. See the [Configuration docs](https://invoke.ai/configuration/invokeai-yaml/) for further detail.
113113

114114
---
115115

docs/astro.config.mjs

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,41 @@ export default defineConfig({
137137
}),
138138
],
139139
redirects: {
140+
'/CODE_OF_CONDUCT': '/contributing/code-of-conduct',
141+
'/RELEASE': '/development/process/release-process',
140142
'/installation': '/start-here/installation',
143+
'/installation/docker': '/configuration/docker',
144+
'/installation/manual': '/start-here/manual',
145+
'/installation/models': '/concepts/models',
146+
'/installation/patchmatch': '/configuration/patchmatch',
147+
'/installation/quick_start': '/start-here/installation',
148+
'/installation/requirements': '/start-here/system-requirements',
141149
'/configuration': '/configuration/invokeai-yaml',
142150
'/features/low-vram/': '/configuration/low-vram-mode/',
143151
'/faq': '/troubleshooting/faq',
152+
'/help/SAMPLER_CONVERGENCE': '/concepts/parameters',
153+
'/help/diffusion': '/concepts/diffusion',
154+
'/help/gettingStartedWithAI': '/concepts/image-generation',
155+
'/nodes/NODES': '/workflows/editor-interface',
156+
'/nodes/NODES_MIGRATION_V3_V4': '/development/guides/api-development',
157+
'/nodes/comfyToInvoke': '/workflows/comfyui-migration',
158+
'/nodes/communityNodes': '/workflows/community-nodes',
159+
'/nodes/contributingNodes': '/development/guides/creating-nodes',
160+
'/nodes/invocation-api': '/development/guides/api-development',
161+
'/contributing/ARCHITECTURE': '/development/architecture/overview',
162+
'/contributing/DOWNLOAD_QUEUE': '/development/architecture/model-manager',
163+
'/contributing/HOTKEYS': '/features/hotkeys',
164+
'/contributing/INVOCATIONS': '/development/architecture/invocations',
165+
'/contributing/LOCAL_DEVELOPMENT': '/development/setup/dev-environment',
166+
'/contributing/MODEL_MANAGER': '/development/architecture/model-manager',
167+
'/contributing/NEW_MODEL_INTEGRATION': '/development/guides/models',
168+
'/contributing/PR-MERGE-POLICY': '/development/process/pr-merge-policy',
169+
'/contributing/TESTS': '/development/guides/tests',
170+
'/contributing/contribution_guides/development': '/development',
171+
'/contributing/contribution_guides/newContributorChecklist': '/contributing/new-contributor-guide',
172+
'/contributing/dev-environment': '/development/setup/dev-environment',
173+
'/contributing/frontend': '/development/front-end',
174+
'/contributing/frontend/state-management': '/development/front-end/state-management',
175+
'/contributing/frontend/workflows': '/development/front-end/workflows',
144176
}
145177
});

docs/src/content/docs/configuration/docker.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ On the [Docker Desktop app](https://docs.docker.com/get-docker/), go to `Prefere
5555

5656
Set up your environment variables. In the `docker` directory, make a copy of `.env.sample` and name it `.env`. Make changes as necessary.
5757

58-
Any environment variables supported by InvokeAI can be set here - please see [Configurations](../configuration.md) for further detail.
58+
Any environment variables supported by InvokeAI can be set here - please see the [configuration docs](/configuration/invokeai-yaml/) for further detail.
5959

6060
At the very least, you might want to set the `INVOKEAI_ROOT` environment variable
6161
to point to the location where you wish to store your InvokeAI models, configuration, and outputs.

docs/src/content/docs/configuration/invokeai-yaml.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ It has two sections - one for internal use and one for user settings:
4949
# Internal metadata - do not edit:
5050
schema_version: 4.0.2
5151

52-
# Put user settings here - see https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/:
52+
# Put user settings here - see https://invoke.ai/configuration/invokeai-yaml/:
5353
host: 0.0.0.0 # serve the app on your local network
5454
models_dir: D:\invokeai\models # store models on an external drive
5555
precision: float16 # always use fp16 precision

docs/src/content/docs/contributing/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ We welcome contributions, whether features, bug fixes, code cleanup, testing, co
1010

1111
## Development
1212

13-
If you’d like to help with development, please see our [development guide](contribution_guides/development.md).
13+
If you’d like to help with development, please see our [development guide](/development/).
1414

15-
**New Contributors:** If you’re unfamiliar with contributing to open source projects, take a look at our [new contributor guide](contribution_guides/newContributorChecklist.md).
15+
**New Contributors:** If you’re unfamiliar with contributing to open source projects, take a look at our [new contributor guide](/contributing/new-contributor-guide/).
1616

1717
## Nodes
1818

19-
If you’d like to add a Node, please see our [nodes contribution guide](../nodes/contributingNodes.md).
19+
If you’d like to add a Node, please see our [nodes contribution guide](/development/guides/creating-nodes/).
2020

2121
## Support and Triaging
2222

@@ -42,7 +42,7 @@ This project is a combined effort of dedicated people from across the world. [C
4242

4343
## Code of Conduct
4444

45-
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.
45+
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.
4646

4747
By making a contribution to this project, you certify that:
4848

docs/src/content/docs/contributing/new-contributor-guide.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ If you're a new contributor to InvokeAI or Open Source Projects, this is the gui
1212
<Steps>
1313
1. Set up your local development environment & fork of InvokAI by following [the steps outlined here](../../development/setup/dev-environment/#initial-setup)
1414

15-
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.
15+
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.
1616

17-
3. Familiarize yourself with [Git](https://www.atlassian.com/git) & our project structure by reading through the [development documentation](development.md)
17+
3. Familiarize yourself with [Git](https://www.atlassian.com/git) & our project structure by reading through the [development documentation](/development/)
1818

1919
4. Join the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord
2020

@@ -29,7 +29,7 @@ If you're a new contributor to InvokeAI or Open Source Projects, this is the gui
2929

3030
Never made an open source contribution before? Wondering how contributions work in our project? Here's a quick rundown!
3131

32-
Before starting these steps, ensure you have your local environment [configured for development](../LOCAL_DEVELOPMENT.md).
32+
Before starting these steps, ensure you have your local environment [configured for development](/development/setup/dev-environment/).
3333

3434
<Steps>
3535
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.

docs/src/content/docs/development/Architecture/invocations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,8 +316,8 @@ new Invocation ready to be used.
316316

317317
Once you've created a Node, the next step is to share it with the community! The
318318
best way to do this is to submit a Pull Request to add the Node to the
319-
[Community Nodes](../nodes/communityNodes.md) list. If you're not sure how to do that,
320-
take a look a at our [contributing nodes overview](../nodes/contributingNodes.md).
319+
[Community Nodes](/workflows/community-nodes/) list. If you're not sure how to do that,
320+
take a look a at our [contributing nodes overview](/development/guides/creating-nodes/).
321321

322322
## Advanced
323323

docs/src/content/docs/development/Architecture/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ The session graph does not support looping. This is left as an application probl
9393

9494
### Invocations
9595

96-
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.
96+
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.
9797

9898
### Services
9999

0 commit comments

Comments
 (0)