Repository navigation
feat(docs): redesign the docs for v7 with search, translations and interactive guides - #10044
Open
joshistoast wants to merge 30 commits into
Open
joshistoast wants to merge 30 commits into
joshistoast wants to merge 30 commits into
Conversation
Astro 7.4.2, Starlight 0.42.7, mermaid 12.2.0, starlight-changelogs 0.7.1, node-gyp 13.1.0 and minor font and markdown-remark bumps. Markdown plugins move to markdown.processor: unified(), replacing the keys Astro 7.4 deprecates. Astro 7.4 requires Node 22.23.4 or newer; mermaid 12 lays out diagrams with ELK and its new default theme.
Colour tokens are generated at build time from the app's themes.ts, with dark-only styles, app-style buttons, tabs, asides, cards and code blocks. Markdown tables get a scrollable wrapper and Mermaid follows the theme; the docs workflow rebuilds when the theme or logo changes and fetches full history for last-updated dates.
Get Started, Guide, Models, Configure & Deploy, Developers, Contribute, Troubleshooting and Releases each get their own sidebar, chosen from a switcher; URLs are unchanged. Sections carry Lucide icons, keep their open state per topic, and prev/next links stay within a topic.
One header on every page with Docs and Showcase links, a v7/v6 version menu, GitHub, Discord and Download. Each page gets a breadcrumb, a right rail with copy-as-Markdown actions, a helpful-or-not prompt, edit and report-issue links, and card-style prev/next links.
Search opens with Ctrl/Cmd+K, scopes results to the current topic with an All docs option, and groups page results by topic. invokeai.yaml settings appear as typed results linking to their anchor in the settings reference.
One picker replaces the nested tabs and updates every command for the chosen setup, remembered across visits. The build fails if any step misses a supported OS and GPU combination.
The page shows the current Invoke Launcher version, date and file sizes, read from GitHub at build time with a committed fallback. A refresh-launcher-release script updates the fallback.
The marketing page gets an animated hero glow, interactive gallery, workflow and before/after demos, an animated What's new bento and a model families section. A community showcase page with a submission form and a home page marquee render once artwork is added.
The build emits a base-path-free index of user-facing pages, headings and topics; a sync script copies it into the app. Docs CI fails when the committed copy drifts from the build.
Editor and Launchpad palettes show Docs results that open the page or heading in a new tab, with an accessible external-link cue. The index loads lazily on the first search; the empty Docs scope lists the docs topics.
The FAQ and system requirements pages linked to old page paths that only resolved through redirects, and the node pack guide linked to a page that no longer exists.
Every English page gets a localized fallback route; content and header links stay in the reader's language, and translated pages reuse English assets and sidebar data. A header language menu, a Crowdin translate link, English canonicals for fallback pages and root-only release pages complete the routing.
Header, footer, search, topic switcher, page tools and MDX components read en.json keys Crowdin can translate, while Starlight's built-in strings keep their shipped translations. Messages with links or markup render from tagged whole messages without raw HTML, and a drift test keeps code and catalog keys in sync.
Hero, tour, What's new, model families and the before/after slider read en.json keys, and the announcement pill links within the reader's locale. The tour demos' mock app UI stays English; their region labels, keyboard hint and announcements are translatable.
pnpm test parses each translated page with the build's frontmatter, MDX and directive parsers and rejects code, links, components or frontmatter the English page lacks. Translated UI strings must keep their placeholders, tags and plural suffixes, and unconfigured locales fail.
crowdin.yml sends the user-facing docs trees and UI strings to Crowdin, and a test keeps every source pattern matching a file. The contributor and docs pages explain the translation flow, and the docs README holds the maintainer runbook.
Distilled models run 4 to 9 steps, semantic search needs no restart, NF4 loads on NVIDIA and AMD. LTX-2 sections use top-level headings with one license section; FAQ typos and the obsolete ram setting are fixed.
Setup steps, role and capability tables, security sections and symptom tables replace long prose. Corrects multi-GPU queueing, session, CLI, password and board-access behaviour, and the key rotation SQL for MySQL.
… pages Numbered pins over a screenshot or app sketch link to a legend written in the page, so translators keep the text. Both pages trade long prose for steps, tables and collapsed detail, with facts checked against the app.
…agram The home page slider now takes any two images; the Upscaling page compares Model only and Refine output. A static pipeline diagram, an annotated panel sketch and per-family tabs replace the sentence-filled table.
…ion pages A new page recommends memory settings for your OS, GPU, VRAM and model format, with one format comparison table. Low-VRAM, FP8, int8 and SDNQ pages become tables, tabs and collapsibles; FP8 Compute gets its own page.
Each pack is a YAML file with a local thumbnail; the grid filters by category and copies Git URLs. The node manager page matches the current app, and the app's docs search index follows the new headings.
A 2px brand ring fades down the frame and drifts as before, sitting directly around the screenshot.
…uction Both pages share the new Edit layout screenshot; their alt text describes it.
Cards are plain text until a family has a cover image, which then sits above the text.
3 of 5 tasks
Collaborator
Author
|
Still working on how weekly challenge submissions should get handled, so don't merge or approve yet |
Each Discord challenge is a folder of winners' images and a YAML file, checked by a strict schema and folder tests. The showcase features the latest week, with an archive, a shareable page per week and a home page strip.
Preserve working-memory calibration and consolidated community packs from main. Refresh the app docs search index after integrating current guides.
Integrate current main and regenerate the Qwen Image search description.
Collaborator
Author
|
Ok ready for review now I think |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rebuilds the docs site for v7 so it looks and behaves like the app, and turns the densest guides from walls of prose into visual, interactive pages.
/showcase/./showcase/challenges/is the archive, and each week gets a shareable page.docs/src/content/challenges/README.mdis the step-by-step guide for adding a week; publishing is a manual pull request for now.max_cache_vram_gbbudget are described correctly;repo::v2;Related Issues / Discussions
Supersedes #9368 (translations for the previous docs site).
QA Instructions
From
docs/with Node 22.23.4 or newer and pnpm 10:pnpm test: 299 passed, 0 failed (includes the translation and i18n-key checks).GITHUB_TOKEN=$(gh auth token) pnpm build: passes; "All internal links are valid." Without a token the changelog loader can hit GitHub's rate limit locally.pnpm run check-deploy-output,pnpm run check-redirects(88 targets) andpnpm run check-app-search-index: pass.invokeai/frontend/webv2:docsSearchProvider.test.ts(8) andLaunchpadCommandPaletteDialog.browser.test.tsx(2): pass.Not done: screenshots aren't attached yet. Forced-colors styles on the annotated pins were written but not rendered in a high-contrast mode.
The challenge pages include the last 10 Discord challenges; layouts were checked with that data and with edge-case fixtures (removed).
To try it:
pnpm build && pnpm preview(search only works in a production build), then open/,/users-guide/image-generation/upscale/,/configuration/optimization/memory-options/and/users-guide/workflows/community-nodes/.Review
Each guide rewrite was reviewed against the code. Material findings were fixed and re-checked, including:
Remaining limits:
main; that link 404s until this merges.!!!admonitions).source_url.Compatibility / Rollout
invokeai/frontend/webv2/src/workbench/palette/docsSearchIndex.json, generated from the docs build. Docs CI fails if it drifts; regenerate withpnpm run sync-app-search-index.docs/README.md).Checklist
What's Newcopy (if doing a release after this PR)Need help on this PR? Tag
@codesmith-botwith what you need.