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

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?