Как писать страницы справки
Эта справка и есть документация NodeWise Studio: для тех, кто пользуется приложением, и для тех, кто меняет его код. Приложение показывает те же страницы в «Справке» на языке интерфейса.
Куда кладётся страница
| Папка | Что в ней |
|---|---|
start/ | Что это за приложение, где взять ComfyUI и приложение, первый час, обновление, удаление. |
connect/ | Подключение приложения к ComfyUI. |
interface/ | По странице на каждую часть окна. |
graph/ | Работа с графом: сборка, проверка, сохранение, запуск в ComfyUI. |
assistant/ | Спросить, Строить, Учиться, кто отвечает, что уходит модели. |
lessons/ | По странице на каждый встроенный урок. |
concepts/ | Понятия ComfyUI для новичка, по одному на страницу. |
reference/ | Форматы, настройки, сочетания клавиш, сообщения, словарь, ограничения. |
trust/ | Приватность, правила содержимого, безопасность, лицензии, доступность. |
dev/ | Код, тесты, сборка, выпуск. |
Как устроена страница
- Первая строка: ссылка на ту же страницу на другом языке:
[English](Page-Name.md)на русской странице,[Русский](Page-Name.ru.md)на английской. - Вторая строка: путь назад:
[Главная](../Home.ru.md) › [Название папки](README.ru.md). - Один заголовок
#, затем короткий абзац о том, про что страница. - Текст: разделы
##. Одна тема на страницу. Если раздел вырос в отдельную тему, дайте ему свою страницу и поставьте на неё ссылку. - Последний раздел:
## См. также(## See alsoна английских страницах) со ссылками на близкие страницы.
Имена файлов: Page-Name.md для английского, Page-Name.ru.md для русского; слова через дефис, каждое с большой
буквы. В каждой папке есть README.md и README.ru.md, где перечислена каждая страница с одной строкой о ней.
Язык
- Простые слова и короткие предложения. Пишите для того, кто ни разу не открывал ComfyUI.
- Слова те же, что показывает приложение, и в том же виде: «помощник», «приложение», «версия графа», «Сочетания клавиш», «вход» и «выход»; по-английски "assistant", "version of the graph". Пункт меню называйте путём: «Файл ▸ Сохранить проект», "File ▸ Save project".
- Без длинных тире для красоты. Без личных сведений: никаких личных серверов, адресов, почты и имён.
- Русская страница говорит то же, что английская. Ни одна не пересказ другой.
Ссылки
- Между страницами только относительные ссылки:
../graph/Subgraphs.ru.md, никогда не адрес репозитория. - Русская страница ссылается на русские страницы (
.ru.md), английская на английские. - Ссылки на код приложения со страниц
dev/тоже относительные:../../../src/main/commands/commit.ts.
Правда
Каждое предложение должно быть верно для текущей сборки. Проверьте его по коду или в запущенном приложении; если код расходится с отчётом или старой страницей, прав код.
- Во время работы предложение, которое пока не подтвердить, получает сразу после себя комментарий HTML: открывающее
<!--, затемverify:и что проверить, затем-->. Страница-заготовка, которую ещё никто не написал, несёт такой же комментарий со словомskeleton:. - Перед выпуском таких комментариев остаться не должно. Предложение, которое здесь не проверить (настоящая установка ComfyUI, Windows, macOS, хранилище паролей вроде KWallet, настоящий экранный диктор), остаётся, прямо в тексте говорит, что это пока не проверено, и попадает в список непроверенного на странице Выпуск версии.
Тест
tests/unit/wiki.test.ts идёт вместе с остальными модульными тестами (npx vitest run tests/unit/wiki.test.ts).
Он проверяет, что:
- каждая страница есть на обоих языках и первые строки ссылаются друг на друга;
- вторая строка ведёт на главную;
- каждая относительная ссылка ведёт на существующий файл;
- оглавление папки перечисляет каждую страницу папки.
Перед выпуском запускайте его так: WIKI_STRICT=1 npx vitest run tests/unit/wiki.test.ts. Тогда он падает ещё и
пока остался хоть один комментарий verify или skeleton.
В приложении
Приложение берёт docs/wiki с собой и открывает в «Справке». Сообщение или подсказка в приложении может ссылаться
на страницу по постоянному идентификатору: см. Ссылки на справку из приложения.