Skip to content

Docs Overhaul#8896

Open
joshistoast wants to merge 45 commits intoinvoke-ai:mainfrom
joshistoast:feat/docs-overhaul
Open

Docs Overhaul#8896
joshistoast wants to merge 45 commits intoinvoke-ai:mainfrom
joshistoast:feat/docs-overhaul

Conversation

@joshistoast
Copy link
Copy Markdown
Collaborator

@joshistoast joshistoast commented Feb 21, 2026

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)

@github-actions github-actions bot added frontend-deps PRs that change frontend dependencies docs PRs that change docs labels Feb 21, 2026
@github-actions github-actions bot added the CI-CD Continuous integration / Continuous delivery label Feb 21, 2026
joshistoast and others added 5 commits February 21, 2026 14:29
- improve homepage;
- enhance some docs pages;
- override some layout components;
- enhance interactivity and qol styling;
- create new download page + component;
- add llms.txt;
- remove unused logo component;
@github-actions github-actions bot added the Root label Feb 24, 2026
@lstein lstein self-assigned this Feb 27, 2026
@lstein
Copy link
Copy Markdown
Collaborator

lstein commented Feb 27, 2026

@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
Copy link
Copy Markdown
Collaborator Author

joshistoast commented Mar 10, 2026

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

@lstein
Copy link
Copy Markdown
Collaborator

lstein commented Mar 15, 2026

Is this PR now ready for a review?

joshistoast and others added 2 commits March 16, 2026 01:50
- update deploy script
- add api and settings component to render generated json
- increase page content width
@github-actions github-actions bot added the python-tests PRs that change python tests label Mar 16, 2026
joshistoast added 3 commits March 16, 2026 01:59
- sorts openapi output map required field
- missing `__name__` attributes
- resolved components name keyerror
@github-actions github-actions bot added the python PRs that change python files label Mar 16, 2026
@lstein
Copy link
Copy Markdown
Collaborator

lstein commented Mar 28, 2026

@joshistoast It looks good to me. Are you able to fix the test error? Astro is complaining about an unsupported version of node.js. With that done, are there any blockers for merging and going live?

@joshistoast joshistoast marked this pull request as ready for review March 30, 2026 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI-CD Continuous integration / Continuous delivery docs PRs that change docs frontend-deps PRs that change frontend dependencies python PRs that change python files python-tests PRs that change python tests Root v6.13.x

Projects

Status: 6.13.x Theme: MODELS

Development

Successfully merging this pull request may close these issues.

2 participants