Document what the application actually does, in all seven languages - #191
Merged
Conversation
The documentation had stood still since April while the application grew to sixteen tabs. It described eight of them, listed two - CHAT and IMAGE GENERATION - that no longer exist, and gave the Control Center eight buttons where there are sixteen. Nothing at all covered the Presets and Settings menus. Every tab and both menus are now written up, from an inventory of the controls each page actually builds rather than from memory. The trees exist in the seven languages the interface itself offers: English, Traditional and Simplified Chinese, German, Russian, French and Italian. Contributor pages - extending the UI, the release process - stay English and Chinese, and the other indexes say where to find them. Title underlines are now measured rather than left at four dashes, counting CJK characters as two columns, which is what docutils does. That and an empty _static directory take the build from 42 warnings to none. tests/unit_test/test_documentation.py keeps the seven trees carrying the same pages, every referenced image present, and no page describing something that has been removed - the failure that let two phantom tabs sit there for months.
|
Up to standards ✅🟢 Issues
|
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
1 participant
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.
The Sphinx documentation had not been touched since 2026-04-21. None of the fourteen merges since then went near it.
What was wrong
CHAT (Chat with bing on front)andIMAGE GENERATION. A missing page reads as missing; a wrong one misleads.clear_allwas fixed.What is here
Every tab and both menus, written from an inventory of the controls each page actually constructs — I dumped the real buttons, checkboxes and combo boxes from a live window rather than working from memory.
In all seven languages the interface itself offers: English, 繁體中文, 简体中文, Deutsch, Русский, Français, Italiano. 18 pages each, 126 pages plus 7 indexes, all linked from the top-level index.
Contributor pages — extending the UI, the release process — stay in English and Chinese; the five new indexes point there rather than pretending otherwise.
Build
42 warnings → 0. Two causes: every title in the repo used a fixed
----underline regardless of title length, andhtml_static_pathpointed at a directory that did not exist. Underlines are now measured, counting CJK characters as two columns since that is what docutils does;_staticexists.140 HTML pages build clean.
Kept honest by tests
tests/unit_test/test_documentation.py— 22 tests: the seven trees carry the same pages, each has exactly one index, the top-level index links them all, every referenced image is really on disk, no page mentions a removed feature, and no underline is short again.Mutation-checked: deleting an Italian page, or re-adding
IMAGE GENERATIONto the English tab list, each fails the suite.880 passed overall, pyflakes silent.
What I did not do
No screenshots for the new pages — I cannot take them. The eight new tabs have no
.. image::line rather than a reference to a file that is not there. The existing screenshots are also from an older build; they are still broadly right for the pages they illustrate, but someone with the app open could usefully refresh them.The five new languages were written by me. Terminology follows the interface strings from #187, so a reader sees the same words in the app and in the docs, but a native speaker's pass would still be worth having before this is advertised.