Docs Overhaul

[joshistoast]

Summary

A complete overhaul of the documentation site, moving away from mkdocs in favor of Astro.

On top of simply moving to a new docs platform, many of the pages are now rewritten, split and merged into a new category structure that feels more streamlined and understandable. Most of the pages are now in MDX, allowing for the importing and usage of custom components like File Trees.

TODO:

• Beef up landing page
• CI workflow docstrings generator, but to JSON instead of markdown;
• CI workflow for API reference generation;
• CI workflow for testing MD links;
• Setup GitHub pages to use GitHub action instead of a branch.
• Maybe we use invoke.ai for this instead of invoke-ai.github.io/

Related Issues / Discussions

QA Instructions

1. cd into docs
2. Install the packages with pnpm install
3. Run the dev server with pnpm run dev
4. Build and serve with pnpm run build && pnpm run start

Merge Plan

Checklist

• The PR has a short but descriptive title, suitable for a changelog
• Tests added / updated (if applicable)
• ❗Changes to a redux slice have a corresponding migration
• Documentation added / updated (if applicable)
• Updated What's New copy (if doing a release after this PR)

[lstein]

@joshistoast I'd like to work my way through this tour de force. When you have a chance, could you explain how I go about rendering and browsing an Astro docs tree? I am not familiar with the system.

[joshistoast]

@joshistoast I'd like to work my way through this tour de force. When you have a chance, could you explain how I go about rendering and browsing an Astro docs tree? I am not familiar with the system.

Just CD into the docs/ directory and run pnpm run dev. Or did you mean something else when you said docs tree?

[lstein]

Tested this out just now and I really like what you've done!
Here are some quick thoughts:

comments on the deploy action

1. I tested the deploy workflow action on my own fork and it worked as expected. However I had to uncomment and fix the typo in the base field of astro.config.ms in order to get it to deploy properly to github pages. The side effect of this is that in dev mode you now need to fetch http://localhost:4321/InvokeAI
2. In addition, the deploy action is generating this warning:

Warning: No `packageManager` field found in `package.json`. Using latest PNPM version instead. We recommend specifying `pnpm@VERSION` explicitly using the `packageManager` field in your `package.json`.
60

comments on the contents

• Under The Creative Engine, the four tiles are not lining up at the top. Is this intended?
• Same thing for Join the Ecosystem
• As a consequence of adding base to the astro config, some absolute URLs, such as /download```, have to be changed to relative URLs, such as download`.
• The Adding Nodes page is empty ?
• Editor Interface should come after Using Workflows and before Adding Nodes.
• Community Nodes has gotten quite long and needs to be broken up into sub-pages if possible. Or at least broken into sections that group nodes by their functionality.
• There are lots of broken links in troubleshooting/faq. For example, see references to low-vram-mode. Is it possible to run a link checker across the pages in dev mode?

[joshistoast]

Good news @lstein, we only need base if we aren't using a custom domain or need to serve as a subdirectory.